Skip to content

docs(claude): adopt GitHub Flow + Branching section #10

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
anilcancakir merged 2 commits into from
May 28, 2026
Merged

docs(claude): adopt GitHub Flow + Branching section #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
753c2f9
docs(claude): adopt GitHub Flow + Branching section
anilcancakir May 28, 2026
85df4c2
docs(copilot): mirror GitHub Flow + Branching from CLAUDE.md
anilcancakir May 28, 2026
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
8 changes: 8 additions & 0 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,14 @@ the consumer's `./bin/fsa` (native AOT, ~110ms warm) is the recommended entry po
4. **README + llms.txt sync**: Watchers / MCP Tools / CLI Commands tables in `README.md` stay in sync with `lib/src/watchers/`, `TelescopeArtisanProvider.mcpTools()`, and `TelescopeArtisanProvider.commands()` respectively.
5. **CHANGELOG under `[Unreleased]`**: every behavioral or interface change lands a bullet under `## [Unreleased]` in `CHANGELOG.md`. Keep-a-Changelog ordering (Added, Changed, Deprecated, Removed, Fixed, Security). Promote to a dated section on tag push.
6. **Green gate + TDD**: `dart format` zero diff + `dart analyze` zero issues + `flutter test --exclude-tags=integration` all green. Red-green-refactor for behavioral changes: failing test first.
7. **GitHub Flow**: one long-lived branch `master` (released, what pub.dev resolves). Cut every task branch from `master`, push, open a PR back into `master`. Releases bump `pubspec.yaml`, promote `## [Unreleased]` in `CHANGELOG.md`, merge the bump PR, then tag the commit on `master`. No `develop` accumulator. See the Branching section below.

## Branching

- One long-lived branch: `master`. Direct pushes blocked by branch protection; everything lands via PR. Matches the flutter, dart-lang/sdk, dart-lang/pub, and Anthropic-ecosystem convention.
- Task branches: cut from `master`, short kebab-case names (`feat/exception-watcher-stack-frames`, `fix/dump-watcher-leak`, `docs/cli-commands-section`). One topic per branch, PR back into `master`. Repo is squash-merge only; the head branch auto-deletes on merge.
- Release: open a `release: X.Y.Z` PR from a topic branch that bumps `pubspec.yaml` `version:` and promotes `## [Unreleased]` to `## [X.Y.Z] - YYYY-MM-DD` with the footer link. Merge, then `git tag X.Y.Z && git push origin X.Y.Z`. The tag triggers `.github/workflows/publish.yml` to push to pub.dev.
- External contributors fork the repo and PR against `master` using the same shape.

## Architecture

Expand Down
8 changes: 8 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,14 @@ the consumer's `./bin/fsa` (native AOT, ~110ms warm) is the recommended entry po
4. **README + llms.txt sync**: Watchers / MCP Tools / CLI Commands tables in `README.md` stay in sync with `lib/src/watchers/`, `TelescopeArtisanProvider.mcpTools()`, and `TelescopeArtisanProvider.commands()` respectively.
5. **CHANGELOG under `[Unreleased]`**: every behavioral or interface change lands a bullet under `## [Unreleased]` in `CHANGELOG.md`. Keep-a-Changelog ordering (Added, Changed, Deprecated, Removed, Fixed, Security). Promote to a dated section on tag push.
6. **Green gate + TDD**: `dart format` zero diff + `dart analyze` zero issues + `flutter test --exclude-tags=integration` all green. Red-green-refactor for behavioral changes: failing test first.
7. **GitHub Flow**: one long-lived branch `master` (released, what pub.dev resolves). Cut every task branch from `master`, push, open a PR back into `master`. Releases bump `pubspec.yaml`, promote `## [Unreleased]` in `CHANGELOG.md`, merge the bump PR, then tag the commit on `master`. No `develop` accumulator. See the Branching section below.

## Branching

- One long-lived branch: `master`. Direct pushes blocked by branch protection; everything lands via PR. Matches the flutter, dart-lang/sdk, dart-lang/pub, and Anthropic-ecosystem convention.
- Task branches: cut from `master`, short kebab-case names (`feat/exception-watcher-stack-frames`, `fix/dump-watcher-leak`, `docs/cli-commands-section`). One topic per branch, PR back into `master`. Repo is squash-merge only; the head branch auto-deletes on merge.
- Release: open a `release: X.Y.Z` PR from a topic branch that bumps `pubspec.yaml` `version:` and promotes `## [Unreleased]` to `## [X.Y.Z] - YYYY-MM-DD` with the footer link. Merge, then `git tag X.Y.Z && git push origin X.Y.Z`. The tag triggers `.github/workflows/publish.yml` to push to pub.dev.
- External contributors fork the repo and PR against `master` using the same shape.

## Architecture

Expand Down