Skip to content

Document test expectations for contributors (OSSF Silver badge compliance) #242

@WilliamBerryiii

Description

@WilliamBerryiii

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_added 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