Skip to content
Permalink
Browse files

Improve contribution guidelines

  • Loading branch information...
sindresorhus committed Jul 28, 2018
1 parent 14a2c4c commit 022ced2682614cebba585b8a8557c6524c092f8f
Showing with 9 additions and 32 deletions.
  1. +1 −1 .gitattributes
  2. +2 −25 contributing.md
  3. +3 −3 create-list.md
  4. +3 −3 pull_request_template.md
@@ -1,3 +1,3 @@
* text=auto
* text=auto eol=lf
*.ai binary
readme.md merge=union
@@ -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

@@ -1,9 +1,9 @@
# Creating Your Own List

- Read the [awesome manifesto](https://github.com/sindresorhus/awesome/blob/master/awesome.md) and ensure your list complies.
- Read the [awesome manifesto](awesome.md) and ensure your list complies.
- Search this list before making a new one, as yours may be a duplicate. If it is, try and contribute to the best one instead of making your own.
- Your awesome list should be named `awesome-list-name` and have the [awesome badge](https://github.com/sindresorhus/awesome/blob/master/awesome.md#awesome-badge), a [license](https://github.com/sindresorhus/awesome/blob/master/awesome.md#choose-an-appropriate-license), and [contribution guidelines](https://github.com/sindresorhus/awesome/blob/master/awesome.md#include-contribution-guidelines). Adding a [code of conduct](http://contributor-covenant.org/) is also strongly recommended. You might find [this Yeoman generator](https://github.com/dar5hak/generator-awesome-list) useful.
- Your awesome list should be named `awesome-list-name` and have the [awesome badge](https://github.com/sindresorhus/awesome/blob/master/awesome.md#awesome-badge), a [license](awesome.md#choose-an-appropriate-license), and [contribution guidelines](awesome.md#include-contribution-guidelines). Adding a [code of conduct](http://contributor-covenant.org/) is also strongly recommended. You might find [this Yeoman generator](https://github.com/dar5hak/generator-awesome-list) useful.
- **Wait at least 30 days after creating a list before submitting it, to give it a chance to mature.**
- Make sure you read the [contribution guidelines](https://github.com/sindresorhus/awesome/blob/master/contributing.md) before submitting a request for your list to be added here.
- **Make sure you read the [list guidelines](pull_request_template.md) before submitting a pull request for your list to be added here.**

Thanks for being awesome!
@@ -15,12 +15,12 @@

## Requirements for your pull request

- I have read and understood the [contribution guidelines](https://github.com/sindresorhus/awesome/blob/master/contributing.md) and the [instructions for creating a list](https://github.com/sindresorhus/awesome/blob/master/create-list.md).
- This pull request has a descriptive title.<br>For example, `Add Name of List`, not `Update readme.md` or `Add awesome list`.
- I have read and understood the [instructions for creating a list](https://github.com/sindresorhus/awesome/blob/master/create-list.md).
- This pull request has a descriptive title in the format `Add Name of List` (Example: `Add Swift`), not `Update readme.md` or `Add awesome list`.
- The entry in the Awesome list should:
- Include a short description about the project/theme of the list. **It should not describe the list itself.**<br>Example: `- [Fish](…) - User-friendly shell.`, not `- [Fish](…) - Resources for Fish.`.
- Be added at the bottom of the appropriate category.
- The list I'm submitting complies with these requirements:
- The list I'm submitting complies with the below requirements.


## Requirements for your Awesome list

0 comments on commit 022ced2

Please sign in to comment.
You can’t perform that action at this time.