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

Spell checking and language cleanup

Browse Source 
Initial run through the spec, checking for language and spelling
issues. Corrected.
This commit is contained in:
Sam Hutchings 2017-05-12 14:10:00 +01:00
parent dee835523b
commit 1d4049f2fa
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
spec.md
View File

@ -77,7 +77,7 @@ _Note: This is only a navigation guide for the specification, and does not defin
- Does not require its own title. - Does not require its own title.
- Must be less than 120 characters. - Must be less than 120 characters.
- Must start with `> ` - Must start with `> `
- Must be on it's own line. - Must be on its own line.
- Must match the description in the packager manager's `description` field. - Must match the description in the packager manager's `description` field.
- Must match GitHub's description (if on GitHub). - Must match GitHub's description (if on GitHub).
@ -108,7 +108,7 @@ progressively greater amount of knowledge."
~ [Kirrily "Skud" Robert, perlmodstyle](http://perldoc.perl.org/perlmodstyle.html) ~ [Kirrily "Skud" Robert, perlmodstyle](http://perldoc.perl.org/perlmodstyle.html)
### Table of Contents ### Table of Contents
**Status:** Required; optional for READMEs less than 100 lines. **Status:** Required; optional for READMEs shorter than 100 lines.
**Requirements:** **Requirements:**
- Must link to all Markdown sections in the file. - Must link to all Markdown sections in the file.
@ -194,7 +194,7 @@ progressively greater amount of knowledge."
- List maintainer(s) for a repository, along with one way of contacting them (e.g. GitHub link or email). - List maintainer(s) for a repository, along with one way of contacting them (e.g. GitHub link or email).
**Suggestions:** **Suggestions:**
- This should be a small list of people in charge of the repo. This should not be everyone with access rights, such as an entire organization, but the people who should be pinged and who are in charge of the directon and maintenance of the repository. - This should be a small list of people in charge of the repo. This should not be everyone with access rights, such as an entire organization, but the people who should be pinged and who are in charge of the direction and maintenance of the repository.
- Listing past maintainers is good for attribution, and kind. - Listing past maintainers is good for attribution, and kind.
### Contribute ### Contribute