Mention CI in CONTRIBUTING's validation step - #70
Merged
Conversation
New contributors had no indication that pushing a PR triggers an automated doc-consistency check; CONTRIBUTING.md only described the manual behavioral validation, which reads as if there's no automation at all.
This was referenced Jul 27, 2026
dmccoystephenson
added a commit
that referenced
this pull request
Aug 3, 2026
New contributors had no indication that pushing a PR triggers an automated doc-consistency check; CONTRIBUTING.md only described the manual behavioral validation, which reads as if there's no automation at all.
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.
Summary
.github/workflows/ci.ymlrunsscripts/check_docs.pyautomatically on every PR. A new contributor reading only CONTRIBUTING.md would have no idea their PR gets an automated doc-consistency check.Research grounding
Docs-only change, no template/phase behavior touched — no RESEARCH.md finding applies.
Test plan
python3 scripts/check_docs.pypassesdrafted by Claude on behalf of Daniel Stephenson