-
Notifications
You must be signed in to change notification settings - Fork 125
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationneeds-triageRequires triage and prioritizationRequires triage and prioritization
Description
Description
The OSSF Silver badge requires projects to document that contributors must add tests when adding new functionality.
OSSF Criterion: tests_documented_added (MUST)
Reference: https://www.bestpractices.dev/en/projects/11532?criteria_level=1#tests_documented_added
Current Gap
| Criterion | Requirement | Current State |
|---|---|---|
tests_documented_added |
Document test expectations for contributions | No explicit test requirement documented for contributors |
Proposed Deliverable
Enhance contribution documentation with explicit test requirements.
Acceptance Criteria
- Add test requirement statement to PR template (
.github/PULL_REQUEST_TEMPLATE.md) - Include checklist item: "Tests added for new functionality"
- Document test writing guidelines in CONTRIBUTING.md or linked doc:
- When tests are required (new functionality, bug fixes)
- When tests may be optional (documentation-only changes)
- Example test structure
- Reference Pester testing framework documentation
- Update OSSF badge form to mark
tests_documented_addedas Met
Additional Context
- OSSF Badge Project: https://www.bestpractices.dev/en/projects/11532
- Related to
test_policy_mandatedcriterion - can be addressed in same PR - See scripts/tests/ for existing test examples
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationneeds-triageRequires triage and prioritizationRequires triage and prioritization