parent
83147814d9
commit
88d7650a83
@ -27,7 +27,7 @@ Standard Readme is designed for open source libraries. Although it’s [historic
|
||||
- [Example Readmes](#example-readmes)
|
||||
- [Related Efforts](#related-efforts)
|
||||
- [Maintainers](#maintainers)
|
||||
- [Contribute](#contribute)
|
||||
- [Contributing](#contributing)
|
||||
- [License](#license)
|
||||
|
||||
## Background
|
||||
@ -102,7 +102,7 @@ To see how the specification has been applied, see the [example-readmes](example
|
||||
|
||||
[@RichardLitt](https://github.com/RichardLitt).
|
||||
|
||||
## Contribute
|
||||
## Contributing
|
||||
|
||||
Feel free to dive in! [Open an issue](https://github.com/RichardLitt/standard-readme/issues/new) or submit PRs.
|
||||
|
||||
|
@ -16,7 +16,7 @@ This is a long description.
|
||||
- [Install](#install)
|
||||
- [Usage](#usage)
|
||||
- [API](#api)
|
||||
- [Contribute](#contribute)
|
||||
- [Contributing](#contributing)
|
||||
- [License](#license)
|
||||
|
||||
## Security
|
||||
@ -49,9 +49,9 @@ This module depends upon a knowledge of [Markdown]().
|
||||
|
||||
## More optional sections
|
||||
|
||||
## Contribute
|
||||
## Contributing
|
||||
|
||||
See [the contribute file](contribute.md)!
|
||||
See [the contributing file](CONTRIBUTING.md)!
|
||||
|
||||
PRs accepted.
|
||||
|
||||
|
@ -12,7 +12,7 @@
|
||||
```
|
||||
```
|
||||
|
||||
## Contribute
|
||||
## Contributing
|
||||
|
||||
PRs accepted.
|
||||
|
||||
|
8
spec.md
8
spec.md
@ -31,7 +31,7 @@ _Note: This is only a navigation guide for the specification, and does not defin
|
||||
- [Extra Sections](#extra-sections)
|
||||
- [API](#api)
|
||||
- [Maintainers](#maintainers)
|
||||
- [Contribute](#contribute)
|
||||
- [Contributing](#contributing)
|
||||
- [License](#license)
|
||||
- [Definitions](#definitions)
|
||||
|
||||
@ -197,7 +197,7 @@ progressively greater amount of knowledge."
|
||||
- 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.
|
||||
|
||||
### Contribute
|
||||
### Contributing
|
||||
**Status**: Required.
|
||||
|
||||
**Requirements:**
|
||||
@ -206,10 +206,10 @@ progressively greater amount of knowledge."
|
||||
- List any requirements for contributing; for instance, having a sign-off on commits.
|
||||
|
||||
**Suggestions:**
|
||||
- Link to a contributing or contribute file -- if there is one.
|
||||
- Link to a CONTRIBUTING file -- if there is one.
|
||||
- Be as friendly as possible.
|
||||
- Link to the GitHub issues.
|
||||
- Link to a Code of Conduct. A CoC is often in the Contribute section or document, or set elsewhere for an entire organization, so it may not be necessary to include the entire file in each repository. However, it is highly recommended to always link to the code, wherever it lives.
|
||||
- Link to a Code of Conduct. A CoC is often in the Contributing section or document, or set elsewhere for an entire organization, so it may not be necessary to include the entire file in each repository. However, it is highly recommended to always link to the code, wherever it lives.
|
||||
- A subsection for listing contributors is also welcome here.
|
||||
|
||||
### License
|
||||
|
Loading…
Reference in New Issue
Block a user