Skip to content

docs: add a written test policy for new functionality - #61

Merged
Navi Bot (project-navi-bot) merged 1 commit into
mainfrom
docs/test-policy
May 25, 2026
Merged

docs: add a written test policy for new functionality#61
Navi Bot (project-navi-bot) merged 1 commit into
mainfrom
docs/test-policy

Conversation

@Fieldnote-Echo

Copy link
Copy Markdown
Member

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, plus pytest for 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.

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>
@qodo-code-review

Copy link
Copy Markdown

Review Summary by Qodo

Add written test policy for new functionality

📝 Documentation

Grey Divider

Walkthroughs

Description
• 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
Diagram
flowchart 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"]

Loading

File Changes

1. CONTRIBUTING.md 📝 Documentation +5/-0

Add mandatory test policy for new functionality

• Adds new ground rule requiring tests for major new functionality
• Specifies that tests must be added to automated test suite (cargo test and pytest)
• Clarifies that changes without tests will be requested to add them before merge
• Fulfills OpenSSF Best Practices silver criterion test_policy_mandated

CONTRIBUTING.md


Grey Divider

Qodo Logo

@qodo-code-review

qodo-code-review Bot commented May 25, 2026

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Qodo Logo

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

codecov Bot commented May 25, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@project-navi-bot
Navi Bot (project-navi-bot) merged commit 8c8929d into main May 25, 2026
21 checks passed
@project-navi-bot
Navi Bot (project-navi-bot) deleted the docs/test-policy branch May 25, 2026 20:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants