docs: add a written test policy for new functionality - #61
Merged
Conversation
Satisfies the OpenSSF Best Practices silver criterion test_policy_mandated: a formal written policy that tests MUST be added when major new functionality is added. Signed-off-by: Nelson Spence <nelson@projectnavi.ai>
Nelson Spence (Fieldnote-Echo)
requested a review
from Navi Bot (project-navi-bot)
as a code owner
May 25, 2026 20:47
Review Summary by QodoAdd written test policy for new functionality
WalkthroughsDescription• Adds written test policy requiring tests for new functionality • Specifies automated test suite requirements (cargo test, pytest) • Satisfies OpenSSF Best Practices silver criterion test_policy_mandated Diagramflowchart LR
A["CONTRIBUTING.md"] -- "adds test policy requirement" --> B["Ground rules section"]
B -- "specifies" --> C["Automated test suite mandate"]
C -- "satisfies" --> D["OpenSSF Best Practices"]
File Changes1. CONTRIBUTING.md
|
There was a problem hiding this comment.
Code Review
This pull request updates the CONTRIBUTING.md file to explicitly state that automated tests (via cargo test and pytest) are required for any new functionality before a merge. There are no review comments, and I have no additional feedback to provide.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
project-navi-bot
approved these changes
May 25, 2026
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.
Adds a one-bullet written test policy to CONTRIBUTING's Ground rules: as major new functionality is added, tests covering it MUST be added to the automated suite (
cargo test, pluspytestfor the Python bindings), and changes that add capability without tests are asked to add them before merge.This satisfies the OpenSSF Best Practices silver criterion
test_policy_mandated— "a formal written policy that as major new functionality is added, tests for the new functionality MUST be added to an automated test suite."Docs-only; no code change.