docs(guide/dev): emphasize importance of running full test suite before committing#368
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates contributor-facing documentation and the repository’s AI instruction files to explicitly require running the full test.sh suite before committing any change, including “trivial” edits, and documents how to respond to test failures that provide RUSTFLAGS skip hints.
Changes:
- Add GitHub alert callouts in
CONTRIBUTING.mdemphasizing full-suite validation before committing. - Update the shared AI-instructions template and all generated AI instruction files to include the same “always run full suite” guidance.
- Document the workflow for tests that fail with
RUSTFLAGS/--cfg pdu_test_skip_*hints.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| template/ai-instructions/shared.md | Updates the shared instruction fragment to emphasize running the full suite and following RUSTFLAGS skip hints. |
| CONTRIBUTING.md | Adds [!IMPORTANT] and [!NOTE] callouts reinforcing full-suite testing and the RUSTFLAGS hint workflow. |
| CLAUDE.md | Mirrors the updated shared testing guidance in the Claude instruction file. |
| AGENTS.md | Mirrors the updated shared testing guidance in the agents instruction file. |
| .github/copilot-instructions.md | Mirrors the updated shared testing guidance in the Copilot instruction file. |
Performance Regression Reportscommit: 12886af There are no regressions. |
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.
This PR updates documentation and AI instruction files to emphasize the critical importance of running the complete test suite before committing any changes, regardless of how trivial they may seem.
Summary
The changes reinforce testing best practices by making it explicit that all types of changes—including documentation edits, comment modifications, and configuration updates—can potentially break formatting, linting, building, tests, or documentation generation across different feature combinations.
Key Changes
RUSTFLAGShintsNotable Details
[!IMPORTANT]and[!NOTE]alert syntax in CONTRIBUTING.md for better visibilityhttps://claude.ai/code/session_01KKiNFj2QH1VCLR2AHyEvN4