docs: align CONTRIBUTING with the shared git and GitHub standard - #365
Merged
Merged
Conversation
CONTRIBUTING required an AI Co-Authored-By trailer and a "generated with assistance" note in PR bodies. The shared Hanalyx standard forbids both: the person opening the pull request owns the change, and a per-commit tool record bakes in a disclosure a project should make deliberately. The repo has followed the standard since bab7b0f, so this file was the last place stating the opposite. Replaces that bullet with the prohibition, and says where authorship transparency actually lives: the failure-mode analysis, which a human writes and signs. Adds the plan-label rule, which had covered code comments but never branch names, commit subjects, or issue titles. Changes the CHANGELOG heading format from an em dash to parentheses. The Doc style check rejects the em dash, while the shared standard leaves the heading format to each project and asks that the choice be written down. Existing headings keep the old separator until the CHANGELOG is swept; docs_check validates the ISO date, not the separator, so both forms pass. Documents the Doc style job, including that it scans changed files whole rather than line by line. Clears 21 em dashes, since the check scans the whole file.
remyluslosius
added a commit
that referenced
this pull request
Jul 26, 2026
CHANGELOG carried 172 style findings, so the next PR to touch it would have inherited the cleanup mid-release. Clearing it now keeps that off the release path. Removes 176 em dashes, resolved by what each clause was doing rather than by one substitution: paired asides became parentheses, bold lead-ins took a colon, appositives a comma, and independent clauses a semicolon or a sentence break. A first pass produced eleven comma splices where an em dash had ended a line introducing an explanation; those are colons now. Migrates all 23 version headings to the parenthesised date form CONTRIBUTING adopted in #365. docs_check validates that a heading carries an ISO date, not which separator precedes it, so both forms pass and no gate changed. Renames "behavior harness" to "check-behavior suite" and cites rule_behavior_harness_test.go in code font. The checker reads "harness" as hype; here it is the shipped artifact's name, so the name stays, in a span the checker exempts. The false positive is filed against the shared tool. Verified content-preserving: after normalising punctuation, the whole file differs by exactly the two intended word changes above. Reference counts are unchanged at 75 PR links, 2 markdown links, and 153 bold spans.
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
1 participant
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.
CONTRIBUTING.mdrequired an AICo-Authored-By:trailer and a "generated withassistance" note in PR bodies. The shared Hanalyx git and GitHub standard forbids
both. The repo has followed the standard since bab7b0f, so this file was the last
place saying the opposite, in the document contributors are pointed at first.
What changes
and states where authorship transparency actually lives: the failure-mode
analysis, which a human writes and signs. A
Co-Authored-By:for a humancollaborator is still welcome.
branch names, commit subjects, and issue titles, which is where it matters.
## vX.Y.Z — YYYY-MM-DDto## vX.Y.Z (YYYY-MM-DD). The Doc style job added in docs: adopt the Hanalyx documentation style guide and CI check #364 rejects the em dash,so the old format was a merge blocker for the next release: every one of the 23
existing version headings fails that check. The shared standard names the
CHANGELOG heading format as a mechanic each project may set for itself,
provided it writes the choice down, which this does.
docs_check.shvalidatesthat a heading carries an ISO date, not which separator precedes it, so both
forms pass and no gate changes.
it scans changed files whole, not line by line, so touching a file means
clearing anything already in it.
Not in this PR
The 23 existing CHANGELOG headings keep the old separator, and
CHANGELOG.mdstill carries roughly 172 style findings. Sweeping it is a single mechanical
change to a public historical record, and it deserves its own review rather than
riding along here. Until it lands, the next PR that touches
CHANGELOG.mdinherits that cleanup.
Verification
make docs-check: passes, 14 checks.make docs-style: passes on the changed file.