This commit is contained in:
Travis Fischer 2018-05-07 10:16:18 -04:00
parent 1535f7cb6e
commit 465849824e
2 changed files with 22 additions and 15 deletions

View file

@ -1,25 +1,30 @@
# Contribution Guidelines # Contribution Guidelines
Please note that this project is released with a Please note that this project is released with a [Contributor Code of Conduct](code-of-conduct.md). By participating in this project you agree to abide by its terms.
[Contributor Code of Conduct](code-of-conduct.md). By participating in this
project you agree to abide by its terms.
--- ---
Ensure your pull request adheres to the following guidelines: Ensure your pull request adheres to the following guidelines:
- Make sure you take care of this - **If you just created something, wait at least 7 days before submitting.** This is to give it some time to mature and ensure it's not just a publish-and-forget type of project.
- And this as well - If you submit a project that is similar to an existing project in the list, argue how it's better.
- And don't forget to check this - Search previous suggestions before making a new one, as yours may be a duplicate.
- Suggested packages should be tested and documented.
- Make an individual pull request for each suggestion.
- Use the following format: `[package](link) - Description.`
- Additions should be added to the bottom of the relevant category.
- Link to the GitHub repo, not npmjs.com.
- Keep descriptions short and simple, but descriptive.
- Don't mention `Node.js` in the description as it's implied.
- Start the description with a capital and end with a full stop/period.
- Don't start the description with `A` or `An`.
- Check your spelling and grammar.
- Make sure your text editor is set to remove trailing whitespace.
- The pull request should have a useful title and include a link to the package and why it should be included.
- New categories or improvements to the existing categorization are welcome, but should be done in a separate pull request.
Thank you for your suggestions! Thank you for your suggestions!
### Updating your PR
## Updating your PR A lot of times, making a PR adhere to the standards above can be difficult. If the maintainers notice anything that we'd like changed, we'll ask you to edit your PR before we merge it. If you're not sure how to do that, [here is a guide](https://github.com/RichardLitt/knowledge/blob/master/github/amending-a-commit-guide.md) on the different ways you can update your PR so that we can merge it.
A lot of times, making a PR adhere to the standards above can be difficult.
If the maintainers notice anything that we'd like changed, we'll ask you to
edit your PR before we merge it. There's no need to open a new PR, just edit
the existing one. If you're not sure how to do that,
[here is a guide](https://github.com/RichardLitt/docs/blob/master/amending-a-commit-guide.md)
on the different ways you can update your PR so that we can merge it.

View file

@ -61,4 +61,6 @@ Contributions welcome! Please read the [contributing guideline](contributing.md)
## License ## License
[![CC0](http://mirrors.creativecommons.org/presskit/buttons/88x31/svg/cc-zero.svg)](http://creativecommons.org/publicdomain/zero/1.0) @ [Travis Fischer](https://github.com/transitive-bullshit) [![CC0](http://mirrors.creativecommons.org/presskit/buttons/88x31/svg/cc-zero.svg)](http://creativecommons.org/publicdomain/zero/1.0)
To the extent possible under law, [Travis Fischer](https://github.com/transitive-bullshit) has waived all copyright and related or neighboring rights to this work.