Skip to content

docs: point branching/release sections at engineering handbook#73

Merged
amcheste merged 1 commit intodevelopfrom
docs/point-contributing-at-handbook
Apr 25, 2026
Merged

docs: point branching/release sections at engineering handbook#73
amcheste merged 1 commit intodevelopfrom
docs/point-contributing-at-handbook

Conversation

@amcheste
Copy link
Copy Markdown
Owner

Summary

Points the branching/release sections of `CONTRIBUTING.md` at the canonical engineering-handbook. Repo-specific content (shellcheck/act/tart prerequisites, `Brewfile.ci` parity rule, VM acceptance test flow, fork guidance) is preserved.

What was wrong

The old `Release Process` section said:

  1. Bumps version on `develop`, commits `chore: release v`
  2. Opens a PR: `develop → main`
  3. Owner approves and merges the PR

That contradicts the canonical rule (already correctly stated in this repo's `CLAUDE.md`) that `develop → main` must be a CLI `git merge --no-ff` — never a GitHub PR, because GitHub's merge button squash-merges by default and destroys commit ancestry, causing merge conflicts on every subsequent release.

Follow-ups (flagged for the user)

  • Repo's default branch is still `main` — should be `develop`. Can be fixed with `/setup-repo amcheste/mac-dev-setup`.

Test plan

  • engineering-handbook#6 is merged before this merges (otherwise handbook links 404 temporarily)
  • CONTRIBUTING.md renders cleanly on GitHub

🤖 Generated with Claude Code

@amcheste amcheste self-assigned this Apr 23, 2026
@github-actions github-actions Bot added the docs label Apr 23, 2026
Copy link
Copy Markdown
Owner Author

amcheste commented Apr 25, 2026

Merge activity

  • Apr 25, 6:57 PM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Apr 25, 6:58 PM UTC: Graphite rebased this pull request as part of a merge.
  • Apr 25, 7:02 PM UTC: @amcheste merged this pull request with Graphite.

Replaces the Branch Model, Commit Convention, and Release Process
sections with a pointer to the canonical engineering-handbook docs.
Repo-specific content (shellcheck/act prerequisites, Brewfile.ci
parity rule, acceptance test flow, fork guidance) is preserved.
@amcheste amcheste force-pushed the docs/point-contributing-at-handbook branch from 04f4607 to 4fa8929 Compare April 25, 2026 18:58
@amcheste amcheste merged commit 42b1a73 into develop Apr 25, 2026
7 checks passed
@amcheste amcheste deleted the docs/point-contributing-at-handbook branch April 25, 2026 19:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant