Skip to content

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

Merged
anilcancakir merged 2 commits into
masterfrom
docs/github-flow
May 28, 2026
Merged

docs(claude): adopt GitHub Flow + Branching section#10
anilcancakir merged 2 commits into
masterfrom
docs/github-flow

Conversation

@anilcancakir
Copy link
Copy Markdown
Contributor

Summary

Codifies the GitHub Flow we now run in this repo, mirroring fluttersdk_dusk:

  • One long-lived branch (master), every task on its own kebab-case branch, PR back into master.
  • Repo is squash-merge only; head branches auto-delete on merge.
  • Releases ship via a release: X.Y.Z PR that bumps pubspec.yaml + promotes ## [Unreleased], then a tag push triggers publish.yml.
  • No develop accumulator (the develop branch was deleted alongside this change).

Changes

  • CLAUDE.md: add Golden Rule 7 (GitHub Flow) + ## Branching section.

Companion infra (already applied)

  • develop branch deleted (local + remote).
  • Repo settings: deleteBranchOnMerge: true, allowSquashMerge: true, allowMergeCommit: false, allowRebaseMerge: false.
  • master branch protection enabled (PR required, no direct push).

- Add Golden Rule 7 (GitHub Flow) covering one long-lived master, task
  branches via PR, and the release-tag mechanism.
- Add Branching section mirroring fluttersdk_dusk: kebab-case task
  branches cut from master, squash-merge only, head auto-deletes.
- Companion infra: develop branch deleted, repo set to squash-only with
  deleteBranchOnMerge=true, master protected (PR required).
Copilot AI review requested due to automatic review settings May 28, 2026 13:57
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Documents the GitHub Flow branching convention adopted by the repo, codifying it in both CLAUDE.md and .github/copilot-instructions.md.

Changes:

  • Add Golden Rule 7 ("GitHub Flow") summarizing the workflow.
  • Add a new ## Branching section detailing task branch naming, release PR shape, and contributor flow.
  • Mirror the same content in .github/copilot-instructions.md.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
CLAUDE.md Adds Golden Rule 7 and a Branching section describing the GitHub Flow process.
.github/copilot-instructions.md Mirrors the same Golden Rule 7 and Branching section for Copilot guidance.

@anilcancakir anilcancakir merged commit 4559faf into master May 28, 2026
2 checks passed
@anilcancakir anilcancakir deleted the docs/github-flow branch May 28, 2026 14:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants