Document when and how tests are run
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 271
- Forks
- 129
- Avg merge
- 3h 46m
- Merged PRs (30d)
- 4
Description
Address OSPS-QA-06.02 security baseline requirements.
Requirement: While active, project's documentation MUST clearly document when and how tests are run.
Recommendation: Add a section to the contributing documentation that explains how to run the tests locally and how to run the tests in the CI/CD pipeline. The documentation should explain what the tests are testing and how to interpret the results.
Control applies to: Maturity Level 3
https://baseline.openssf.org/versions/2025-10-10#osps-qa-0602
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the repository's contributing documentation and inspect the existing test and CI/CD instructions. Document how to run tests locally and in the pipeline, what they cover, and how to interpret results. Done means the documentation addresses every part of OSPS-QA-06.02.
Written by the indexing model from the issue text.
Assessment
- Domain
- ci-cd, documentation, testing-qa
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100