Skip to content

docs(contrib): add branch-workflow section and pre-push hook#91

Merged
Gavin-Borges merged 2 commits into
mainfrom
docs/branch-workflow
Jun 30, 2026
Merged

docs(contrib): add branch-workflow section and pre-push hook#91
Gavin-Borges merged 2 commits into
mainfrom
docs/branch-workflow

Conversation

@Gavin-Borges

@Gavin-Borges Gavin-Borges commented Jun 28, 2026 •
edited
Loading

Copy link
Copy Markdown
Owner

Summary

  • Adds Branch Naming & PR Workflow section to CONTRIBUTING.md: typed-prefix table (feat/ fix/ docs/ chore/ data/ results/ refactor/ security/ release/), step-by-step workflow example, and explanation of local/remote enforcement layers.
  • Adds scripts/hooks/pre-push: dual-gate hook that (1) blocks direct pushes to main and (2) runs fast test suite (-m "not heavy and not slow") before any push.
  • Updates scripts/hooks/install.sh to deploy pre-push alongside pre-commit and commit-msg.
  • Fixes stale 'black' reference in the Code Style section (project uses ruff format).
  • Updates PR checklist with hook-installation and branch-naming items.

Test plan

  • install.sh HOOKS array now includes pre-push
  • pre-push hook ran all ~1097 fast tests clean on push
  • Direct push to main is blocked locally; git push --no-verify available for admin override
  • GitHub branch ruleset enforces same policy at the remote (apply-branch-ruleset.ps1)

@Gavin-Borges Gavin-Borges changed the title Docs/branch workflow docs(contrib): add branch-workflow section and pre-push hook Jun 28, 2026
@Gavin-Borges
docs(contrib): add branch-workflow section, pre-push hook, and PR che…
82ba049 
…cklist update

Adds a typed branch naming convention table and step-by-step PR workflow
to CONTRIBUTING.md so contributors understand the feature-branch -> CI ->
merge path. Adds a pre-push hook that blocks direct pushes to main locally,
mirroring the GitHub branch ruleset enforcement. Updates install.sh to
deploy all three hooks (pre-commit, commit-msg, pre-push). Fixes stale
'black' reference in the code-style section to reflect the ruff-format
toolchain.

Signed-off-by: Gavin Borges <gavinmborges1104@gmail.com>
@Gavin-Borges
fix(hooks): expand pre-push to include fast test gate alongside main-…
cfa8b34 
…branch guard

Signed-off-by: Gavin Borges <gavinmborges1104@gmail.com>
@Gavin-Borges
Gavin-Borges force-pushed the docs/branch-workflow branch from d126821 to cfa8b34 Compare June 30, 2026 00:25
@Gavin-Borges
Gavin-Borges merged commit 6639f8c into main Jun 30, 2026
17 checks passed
@Gavin-Borges
Gavin-Borges deleted the docs/branch-workflow branch June 30, 2026 00:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@Gavin-Borges