Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 3.22 KB

CONTRIBUTING.md

File metadata and controls

46 lines (30 loc) · 3.22 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.

Important!

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 requests for additions to awesome-awesome-nodejs before making a new one - your request may be a duplicate.
  • Make an individual pull request for each suggestion to awesome-awesome-nodejs.
  • All awesome lists added to awesome-awesome-nodejs should be in the master awesome list. If they're not already, now's a great time to add them!
  • Suggestions for improvements to the awesome list are always 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.

Suggestions for ammendments to these guidelines are always welcome - feel free to submit an issue or pull request.

How to: Add a Node.js awesome list to to awesome-awesome-nodejs

If you have something awesome to contribute to awesome-awesome-nodejs list, this is how you can do it.

You'll need to have a GitHub account - you can register here!

  1. Access awesome-awesome-nodejs's GitHub page here
  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, the maintainers of awesome-awesome-nodejs 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-awesome-nodejs list guidelines. We're always happy to help in any way we can.

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