Skip to content

docs: codify branching, release, and PR promotion procedure #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Kaos599 merged 1 commit into from
Sep 21, 2026
Merged

docs: codify branching, release, and PR promotion procedure #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,10 +174,19 @@ change `SKILL.md` and its reference files together: anything too long for the
skill body belongs in `skills/jev-writer/references/`, and `SKILL.md` should
point at it rather than repeat it.

## Branching, Release, and PR Procedure

All code and documentation changes must follow this strict promotion procedure:

1. **Commit to a dedicated feature branch**: Never commit directly to `dev` or `main`.
2. **Open a PR into `dev` and check CI**: Create a PR targeting `dev`, watch CI runs (`CI/test` on Node 20 and 22, plus pack validation), and verify all checks pass.
3. **Merge into `dev`**: Once CI passes and changes are verified, merge the PR into `dev`.
4. **Promote from `dev` to `main` via PR**: Open a PR from `dev` into `main`, verify all file changes contain zero personal or private data, confirm all CI checks pass on `main`, and merge.

## Before you open a PR

```bash
npm test # node:test, 67 tests, all must pass
npm test # node:test, 72 tests, all must pass
node src/cli.mjs doctor # validates every pack and makes one live call
```

Expand Down
9 changes: 9 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,15 @@ node src/cli.mjs doctor
node src/cli.mjs run ./exports
```

## Branching, Release, and PR Procedure

All code and documentation changes follow this strict promotion workflow:

1. **Feature branch**: Make commits to a dedicated feature branch (never directly to `dev` or `main`).
2. **PR into `dev` & CI verification**: Open a PR targeting `dev`, watch CI (`CI/test` on Node 20 and 22, pack validation), and ensure all checks pass.
3. **Merge into `dev`**: Once CI passes and changes are verified, merge the PR into `dev`.
4. **Promote from `dev` to `main` via PR**: Open a PR from `dev` into `main`, verify all changes contain zero personal or private data, confirm all CI checks pass on `main`, and merge.

## Conventions

- **ESM only**, Node >= 20, no TypeScript, no build step.
Expand Down
Loading