docs: clarify validation and PR workflow#40
Merged
Merged
Conversation
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
Clarify repository validation expectations and clean up the pull request workflow documentation.
Changes in this PR:
AGENTS.mdCONTRIBUTING.md# Pull Requestheading from the PR templateWhy
Recent work exposed a recurring failure mode where focused tests were run successfully but CI later failed on formatting or documentation validation.
The repository already had validation guidance, but it was not explicit about which validation paths should be run when Python, TypeScript, Markdown, or multiple file types are modified.
This PR makes those expectations clearer for both human contributors and coding agents.
The PR template cleanup removes a redundant top-level heading that was appearing in rendered pull request descriptions.
Example metadata
Checklist
Notes
Validation: