Skip to content

docs: add git workflow hygiene section - #111

Merged
CodeSigils merged 1 commit into
mainfrom
docs/git-workflow-hygiene
Sep 23, 2026
Merged

CodeSigils merged 1 commit into
mainfrom
docs/git-workflow-hygiene

Conversation

@CodeSigils

Copy link
Copy Markdown
Owner

Project

Docs — proposals/ROADMAP.md. No list entry or payload change.

Why it belongs

Adds a concise Git workflow hygiene section capturing four operational lessons from the
contract-monitor wave (PRs #105–#110) that were previously only implicit:

  1. Squash-merge every PR (gh pr merge N --squash --delete-branch) — one commit per PR, remote branches self-clean.
  2. Direct-merge bot PRs — main has no required status checks, so GitHub declines --auto on already-mergeable PRs
    (Pull request is in clean status (enablePullRequestAutoMerge)); workflow-created PRs must be merged with a direct
    gh pr merge N --squash --delete-branch.
  3. All changes land as GitHub-signed squash merges — main requires verified signatures (required_signatures: true);
    unsigned direct pushes are rejected (GH006). Never push to main directly.
  4. Pushing workflow files needs a workflow-scope token — a fine-grained PAT without workflow scope is refused for
    .github/workflows/**.

Placed next to the existing "Solo evaluation branch policy" section, matching the file's terse reference style.

Quality evidence

Checklist

  • One project per PR.
  • Read CRITERIA.md / contribution guidance before proposing.
  • This is a docs/maintenance change, not a list entry — format and alphabetical rules do not apply.
  • Description uses independently verifiable facts.
  • Not a tutorial, sample, or commercial/promotional material.
  • No new advisory signals introduced.
  • Did not edit advisory-baseline.json or repo-exceptions.json.
  • All local tests pass (uv run pytest / lint as applicable).
  • Revision-history / implementation-record entry included.
  • Opened against the default branch.

@CodeSigils
CodeSigils merged commit 8e47b30 into main Sep 23, 2026
6 checks passed
@CodeSigils
CodeSigils deleted the docs/git-workflow-hygiene branch September 23, 2026 12:17
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.

1 participant