Improve contribution guidelines
This commit is contained in:
@@ -2,32 +2,9 @@
|
||||
|
||||
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.
|
||||
|
||||
# The pull request should have a useful title. Pull requests with `Update readme.md` as title will be closed right away because I'm so tired of nobody reading this document. Please carefully read everything in `Adding to this list`.
|
||||
## Adding a awesome list
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Adding to this list](#adding-to-this-list)
|
||||
- [Creating your own awesome list](#creating-your-own-awesome-list)
|
||||
- [Adding something to an awesome list](#adding-something-to-an-awesome-list)
|
||||
- [Updating your Pull Request](#updating-your-pull-request)
|
||||
|
||||
## Adding to this list
|
||||
|
||||
Please ensure your pull request adheres to the following guidelines:
|
||||
|
||||
- Search previous suggestions before making a new one, as yours may be a duplicate.
|
||||
- Make sure the list is useful before submitting. That implies it has enough content and every item has a good succinct description.
|
||||
- Make an individual pull request for each suggestion.
|
||||
- Use [title-casing](http://titlecase.com) (AP style).
|
||||
- Use the following format: `[List Name](https://github.com/user/repo#readme)` *(Note how `#readme` is appended to the link)*
|
||||
- Link additions should be added to the bottom of the relevant category.
|
||||
- New categories or improvements to the existing categorization are welcome.
|
||||
- Check your spelling and grammar.
|
||||
- Make sure your text editor is set to remove trailing whitespace.
|
||||
- The pull request and commit should have a useful title.
|
||||
- The body of your commit message should contain a link to the repository.
|
||||
|
||||
Thank you for your suggestions!
|
||||
Please ensure your pull request adheres to the [list guidelines](pull_request_template.md).
|
||||
|
||||
## Creating your own awesome list
|
||||
|
||||
|
Reference in New Issue
Block a user