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

Merge pull request #39 from RichardLitt/feat/add-maintainers

Browse Source 
Added maintainers to spec
This commit is contained in:
Richard Littauer 2016-12-28 10:41:43 -05:00 committed by GitHub
commit 4e8548cf50
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
spec.md
View File

@ -184,6 +184,17 @@ progressively greater amount of knowledge."
- Describe caveats.
- If using an external API generator (like go-doc, js-doc, or so on), point to an external `API.md` file. This can be the only item in the section, if present.
### Maintainer(s)
**Status**: Required.
**Requirements:**
- Must be called `Maintainer` or `Maintainers`.
- List maintainer(s) for a repository, along with one way of contacting them (e.g. GitHub link or email).
**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.
- Listing past maintainers is good for attribution, and kind.
### Contribute
**Status**: Required.
@ -197,6 +208,7 @@ progressively greater amount of knowledge."
- Be as friendly as possible.
- Link to the GitHub issues.
- Link to Code of Conduct. This is often in Contribute, or organization wide, so may not be necessary for each module.
- A subsection for listing contributors is also welcome here.
### License
**Status:** Required.