-
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 have a formal written policy that as major new functionality is added to the software, tests for that functionality must be added to the automated test suite.
OSSF Criterion: test_policy_mandated (MUST)
Reference: https://www.bestpractices.dev/en/projects/11532?criteria_level=1#test_policy_mandated
Current Gap
| Criterion | Requirement | Current State |
|---|---|---|
test_policy_mandated |
Formal policy requiring tests for new functionality | CONTRIBUTING.md does not explicitly mandate tests |
Proposed Deliverable
Update CONTRIBUTING.md to include a formal test policy section.
Acceptance Criteria
- Add "Testing Requirements" section to CONTRIBUTING.md
- State that new functionality MUST include tests
- Define minimum test coverage expectations for new code
- Document test location conventions:
- PowerShell tests in
scripts/tests/ - Test file naming convention (
*.Tests.ps1)
- PowerShell tests in
- Document how to run tests locally (
npm run test) - Reference the automated PR validation workflow
- Update OSSF badge form to mark
test_policy_mandatedas Met
Additional Context
- OSSF Badge Project: https://www.bestpractices.dev/en/projects/11532
- Related to
tests_documented_addedcriterion - Current test suite: 262 tests in Pester framework
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationneeds-triageRequires triage and prioritizationRequires triage and prioritization