# Dev Workflow

> Development workflow for this repository. Run `make help` to see available targets. Use when this capability is needed.

- Skill: `tomevault-io/dev-workflow` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add tomevault-io/dev-workflow`
- Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/dev-workflow/raw
- Safety review: pending (external: skill-scanner PASS, skillspector PASS)
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Productivity
- Author: tomevault-io (https://skillmd.com/u/tomevault-io)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/tomevault-io/dev-workflow

---


# Development workflow

This project uses a Makefile-based build system.

## Getting started

Run `make help` to see all available targets and understand the build workflow.

```bash
make help
```

## Pull request descriptions

**CRITICAL: You MUST create and maintain a PR description file for every branch.**

This file describes what's happening on the branch. Update it before every push.

1. Create `.github/pr/<slug>.md` with a descriptive slug (e.g., `add-auth-logging.md`, `fix-parser-edge-case.md`)
2. Use this format:

```markdown
# component: verb explanation

Brief description of what this change does and why.

## Changes

- `path/to/file.lua` - what it does
- `path/to/other.lua` - what it does
```

**Guidelines:**
- Choose a descriptive, kebab-case slug
- Title format: `component: verb explanation` (sentence case)
- Keep descriptions concise but include key decisions and tradeoffs
- **Update the file before every push** to reflect the current state of the branch

---
> Converted and distributed by [TomeVault](https://tomevault.io/claim/whilp) — claim your Tome and manage your conversions.
<!-- tomevault:4.0:skill_md:2026-04-11 -->