saturneric/standard-readme
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add linting requirement

Browse Source 
Closes #37
This commit is contained in:
Richard Littauer 2017-05-08 14:52:53 +02:00
parent 24938bbe2d
commit f3525d4313
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
spec.md
View File

@ -9,7 +9,8 @@ A compliant README must satisfy all the requirements listed below.
- Sections must appear in order given below. Optional sections may be omitted. - Sections must appear in order given below. Optional sections may be omitted.
- Sections must have the titles listed below, unless otherwise specified. - Sections must have the titles listed below, unless otherwise specified.
- Must be new lines between each section. - Must be new lines between each section.
- Must not contain broken links - Must not contain broken links.
- If there are code examples, they should be linted in the same way as the code is linted in the rest of the project.
**Suggestions:** **Suggestions:**
- A "Back to Top" link for longer sections can be useful, but is not required by any means. - A "Back to Top" link for longer sections can be useful, but is not required by any means.