Skip to content

Latest commit

 

History

History
51 lines (36 loc) · 3.32 KB

contributing.md

File metadata and controls

51 lines (36 loc) · 3.32 KB
Raw

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. 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.
  • Please put your new addition at the end of the list of whatever section it is most relevant to. If you don't find a section that it belongs in, please make one.
  • Please don't use bold or italics unless it's somehow appropriate to the link.
  • 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.
  • 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.
  • Please 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!

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/sdras/awesome-actions
  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. 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.

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