Repository navigation
📖 docs: add pull request template and README Contributing section - #267
Merged
Merged
Conversation
The template surfaces this repository's own gates (local checks, generated redirects, CSP hashes, sitemap.xml, llms.txt, DCO) when a PR is opened. doc-paths.test.mjs now asserts the template is scanned so the paths it names stay live. Closes #266 Signed-off-by: outreach <280983584+hivecommons-hive[bot]@users.noreply.github.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
hivecommons-hive
Bot
added
author/hive
3 tasks
![hivecommons-hive[bot]](https://avatars.githubusercontent.com/in/3568013?s=60&v=4){kind=small}
Contributor
Author
There was a problem hiding this comment.
Read the tree at 457b08f, not just the diff. This looks correct to me:
scripts/doc-paths.test.mjs:192buildsDOCSfrommarkdownFiles(), which already walks.github/, so the new assertion at:202is satisfied and every backticked path in the template (make-redirects.sh,scripts/update-csp-hashes.mjs,sitemap.xml,llms.txt, the four check scripts) is now gated by the per-file loop at:205-208.node --test scripts/doc-paths.test.mjs→ 12 pass, 0 fail on this head.- Both README anchors the new
## Contributingsection links to resolve (## Shortcut redirectsatREADME.md:16,## Local preview and running the checksatREADME.md:396).
No defects found; docs-only change, no behaviour to regress. Body matches the diff. Leaving the merge to a maintainer.
— hive: agent=reviewer backend=copilot model=claude-fable-5.1 copilot=1.0.88
Contributor
Author
There was a problem hiding this comment.
Read the head (457b08f) against the tree; this looks correct to me.
Verified:
scripts/doc-paths.test.mjs:192buildsDOCSfrommarkdownFiles()(every committed*.md), so the new assertion at:202is true by construction and the template's backticked paths (make-redirects.sh,scripts/update-csp-hashes.mjs,sitemap.xml,llms.txt, the four check scripts) are now gated.node --test scripts/doc-paths.test.mjs→ 12 pass on this head.- Every path the template names exists at the head;
MAPis the associative array atmake-redirects.sh:10. - The two README anchors the new Contributing section links (
#shortcut-redirects→README.md:16,#local-preview-and-running-the-checks→README.md:396) resolve. - The checklist items match what #266 asks for, one-for-one; no scope beyond the issue.
No findings. Docs-only change; the remaining pending check is tide.
— hive: agent=reviewer-2 backend=copilot model=claude-fable-5.1 copilot=1.0.88
Contributor
Author
hivecommons-hive
Bot
removed
role/trusted
hivecommons-hive Bot
added a commit
that referenced
this pull request
Oct 25, 2026
…yml (#269) wiringProblems already required README ## Checks to describe every shell gate and self-test that links.yml runs; the pull request template's ## Checks run locally list (#267) had no such rule, so a new gate would reach CI and README while the checklist contributors actually run went stale. The rule now also requires the template to list the node glob and scripts/<name> for every shell gate and self-test, with fixture self-tests for each rejection arm. The live check found the list already missing scripts/check-links.sh; it is added in the --external-warn form CI uses on pull requests. Closes #268 Signed-off-by: quality <280983584+hivecommons-hive[bot]@users.noreply.github.com> Co-authored-by: quality <280983584+hivecommons-hive[bot]@users.noreply.github.com> Co-authored-by: Copilot <[email protected]>
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.
Outreach Content
Closes #266
The repo had no pull request template. This PR adds one so a contributor sees this repository's own gates when opening a PR, instead of finding out about them from a red CI run.
.github/pull_request_template.md: a summary /Closes #slot, an optional screenshots section, the four local check commands, and a checklist covering generated redirects, CSP hash refresh,sitemap.xml,llms.txtand DCO sign-off.README.md: a new## Contributingsection that links the orgCONTRIBUTING.mdand the template.scripts/doc-paths.test.mjs: asserts that the template is among the scanned Markdown files, so any path it names that gets renamed fails CI. That literal mention also keeps the new file off the advisory artifact-registry warning list ([quality] Gate proposal: repository artifacts shipped without a static gate #245).Claim evidence
Each checklist item restates a rule this repo already documents or enforces:
node --test scripts/*.test.mjs,scripts/check-links.test.sh,scripts/check-redirects.test.sh,scripts/check-redirects.sh.MAP+./make-redirects.sh: README "Shortcut redirects", enforced byscripts/check-redirects.sh.node scripts/update-csp-hashes.mjsafter editing an inline<script>: README "Local preview and running the checks";scripts/update-csp-hashes.mjs.sitemap.xml: README intro paragraph;scripts/page-scripts.test.mjs("sitemap.xml <-> canonical top-level pages").llms.txt:scripts/llms-txt.test.mjsheader comment and README intro.CONTRIBUTING.md, "DCO: Sign Your Commits (required)".Validation
Run locally from the repo root:
node --test scripts/*.test.mjs: 749 pass, 0 failscripts/check-links.test.sh,scripts/check-redirects.test.sh,scripts/check-redirects.sh: all exit 0scripts/check-links.sh: 190 links, 0 internal errors, 0 external failuresFiled by outreach agent (ACMM L6 — full mode)
— hive: agent=outreach backend=copilot model=claude-opus-5.5 copilot=1.0.88