Basic project website content
ID |
openssf_flossbp/basic_project_website_content |
Severity |
high |
Category |
Basics |
Levels |
Passing |
Optional |
false |
Description
The project website MUST succinctly describe what the software does (what problem does it solve?).
Rationale
Contributors need to understand not only how to contribute, but also the overall contribution process, so that they will understand how their work could be incorporated and what the expectations are after the initial submission.
This means that wherever the project describes how to contribute, the project must include (directly or by reference) information on the contribution process. Note that criterion "interact" (listed earlier) requires that the contribution information be on the project website.
Verification
The project site should contain a document with a clear description. This MUST be in language that potential users can understand (e.g., it uses minimal jargon).
The project website MUST provide information on how to: obtain, provide feedback (as bug reports or enhancements), and contribute to the software.
The information on how to contribute MUST explain the contribution process (e.g., are pull requests used?)
The information on how to contribute SHOULD include the requirements for acceptable contributions (e.g., a reference to any required coding standard).