WOSPM0002
Idenditiy
| Property | Value |
|---|---|
| code | WOSPM0002 |
| title | README |
| message | Every open source project should have a README file. |
| type | MetricType::ERROR |
Rationale
Make a README. Because no one can read your mind (yet).
README document is the first place that user faces before using your project or contributing to it. You should create it even if your project is not complete enough. You can use your README to answer many questions, like how you handle contributions, what the goals of the project are, and information about licenses and attribution. For more to read and consider, following documents will help you.
WOSPM also thinks having README is the origin of many other metrics such as WOSPM0006, WOSPM0007, WOSPM0008, etc.