docs: add review workflow checks - #2
Merged
Merged
Conversation
PerfectPan
force-pushed
the
feat/review-workflow-template
branch
2 times, most recently
from
July 8, 2026 12:52
dea363b to
2c6ca07
Compare
Generated with Codex Co-Authored-By: Codex <noreply@openai.com>
PerfectPan
force-pushed
the
feat/review-workflow-template
branch
from
July 8, 2026 13:08
2c6ca07 to
f320928
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Motivation
This template should make the reusable project workflow explicit without overloading terms like harness or delivery. The core template needs local commit-time guardrails, a clear review path, conventional PR/MR titles, repository checks, documentation boundaries, architecture stewardship guidance, and a concrete place to configure branch protection after each repository is created.
Implementation Notes
.githooks/pre-commitrunsgit diff --cached --checkand./scripts/check-repository.sh --stagedbefore local commits.scripts/install-git-hooks.shinstalls the local hook by settingcore.hooksPathto.githooksand refuses to overwrite an existing custom hooks path unless--forceis provided..github/workflows/review.ymlrunsrepository checkson pushes tomainand PRs, and runsconventional PR titlewhen PRs are opened, edited, reopened, synchronized, or marked ready for review.scripts/check-repository.shchecks required template files, tracked generated/local artifacts, obvious secrets/private paths, and PR/MR template drift. It supports a--stagedmode for commit hooks.scripts/check-pr-title.shenforcestype(scope): summarywith conventional types.scripts/configure-github-repository.shis the post-create setup entrypoint for GitHub branch protection. It defaults to dry-run, infers the GitHub default branch whenghis available, requires--branchwhen it cannot infer, and only updates GitHub when called with--apply.docs/README.mddefines the docs boundary: current architecture, development guides, operational runbooks, references, and onboarding tutorials belong indocs/; proposals and decision history belong inrfcs/; collaboration policy and AI-agent instructions stay inCONTRIBUTING.mdandAGENTS.md.Validation
./scripts/check-repository.sh./scripts/check-repository.sh --staged.githooks/pre-commit./scripts/check-pr-title.sh "docs: add review workflow checks"Update docsscripts/install-git-hooks.shpreserves an existing customcore.hooksPathunless--forceis passedgh:./scripts/configure-github-repository.sh --repo PerfectPan/project-templateghbut explicit branch:PATH=/usr/bin:/bin ./scripts/configure-github-repository.sh --repo PerfectPan/project-template --branch mainghand without branch fails with a concrete errorgit diff --checkandgit diff --cached --checkharness,delivery.md, andrepository-hygienetermsEvidence
check-repository: ok (staged).main, requiring one approving review, stale review dismissal, last-push approval, linear history, resolved conversations, and therepository checks/conventional PR titlestatus checks.ghdry-run path fails unless--branchis passed, so it does not silently guessmainin environments that cannot inspect GitHub.harness,delivery.md,repository-hygiene, and old script paths returned no matches.Safety Checklist
Follow-up Risks