Skip to content

Add formal test policy to CONTRIBUTING.md for OSSF Silver badge compliance #241

@WilliamBerryiii

Description

@WilliamBerryiii

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)
  • Document how to run tests locally (npm run test)
  • Reference the automated PR validation workflow
  • Update OSSF badge form to mark test_policy_mandated as Met

Additional Context

Metadata

Metadata

Labels

documentationImprovements or additions to documentationneeds-triageRequires triage and prioritization

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions