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

fix: Add language specific rules for naming

Browse Source 
closes #81.
This commit is contained in:
Richard Littauer 2018-08-20 10:37:42 -04:00
parent 89a52bff26
commit 7c68d892fd
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
spec.md
View File

@ -6,10 +6,10 @@ A compliant README must satisfy all the requirements listed below.
**Requirements:** **Requirements:**
- Be called README.md (with capitalization). - Be called README.md (with capitalization).
- If the project supports i18n, the file must be named accordingly: `README.de.md`, where `de` is the BCP 47 Language tag. For naming, prioritize non-regional subtags for languages. - If the project supports i18n, the file must be named accordingly: `README.de.md`, where `de` is the BCP 47 Language tag. For naming, prioritize non-regional subtags for languages. If there is only one README and the language is not English, than a different language in the text is permissible without needing to to specify the BCP tag: e.g., `README.md` can be in German if there is no `README.md` in another language. Where there are multiple languages, `README.md` is reserved for English.
- Be a valid Markdown file. - Be a valid Markdown file.
- 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. If the README is in another language, the titles must be translated into that language.
- 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. - If there are code examples, they should be linted in the same way as the code is linted in the rest of the project.