ch0ic3/awesome
1
0
Fork 0
mirror of https://github.com/sindresorhus/awesome.git synced 2024-12-23 01:16:08 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
6ccd5d54e2
awesome/contributing.md
Austin Soplata 6ccd5d54e2 Add PR template mention to Contributing guideline 
The Pull Request template
https://github.com/sindresorhus/awesome/blob/master/pull_request_template.md
is not explicitly mentioned in the Contribution Guidelines page, and it
includes additional requirements not seen by the time someone is
creating a Pull Request. This fixes that.

Changes to be committed:
	modified:   contributing.md
2018-05-14 16:21:10 -04:00

3.5 KiB
Raw Blame History

Contribution Guidelines

Please note that this project is released with a Contributor Code of Conduct. 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.

Table of Contents

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 (AP style).
  • Use the following format: [List Name](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!

Creating your own awesome list

To create your own list, check out the instructions.

Adding something to an awesome list

If you have something awesome to contribute to an awesome list, this is how you do it.

You'll need a GitHub account!

  1. Access the awesome list's GitHub page. For example: https://github.com/sindresorhus/awesome
  2. Click on the readme.md file: Step 2 Click on Readme.md
  3. Now click on the edit icon. Step 3 - Click on Edit
  4. You can start editing the text of the file in the in-browser editor. Make sure you follow guidelines above. You can use GitHub Flavored Markdown. Step 4 - Edit the file
  5. Say why you're proposing the changes, and then click on "Propose file change". Step 5 - Propose Changes
  6. Make sure your pull request follows the awesome-* list pull request template, then submit the pull request!

Updating your Pull Request

Sometimes, a maintainer of an awesome list will ask you to edit your Pull Request before it is included. This is normally due to spelling errors or because your PR didn't match the awesome-* list guidelines or the PR template.

Here is a write up on how to change a Pull Request, and the different ways you can do that.