Skip to content
This repository has been archived by the owner on Nov 24, 2019. It is now read-only.

Latest commit

 

History

History
71 lines (33 loc) · 2.94 KB

CONTRIBUTING.md

File metadata and controls

71 lines (33 loc) · 2.94 KB
Raw

Contribution Guidelines

  • Use the following format: [Visible URL Label](Link URL) - Description..
  • The link should be the name of the package or project.
  • Keep descriptions concise, clear and simple.
  • New categories, or improvements to the existing ones are also welcome.

Quality Standard

To stay on the list, projects should follow these quality standards:

  • Generally useful to the community
  • Actively maintained (even if that just means acknowledging open issues when they arise)
  • Stable
  • Documented

Thanks to all contributors, you're awesome and wouldn't be possible without you!

How to Contribute?

Contributing is easy, no need to install anything, just use your browser.

Adding Something to any 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: stefanwalther/awesome-picasso.js.

  2. Click on the README.md file:

Step 2 Click on Readme.md

  1. Now click on the edit icon.

Step 3 - Click on Edit Icon

  1. 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 - Make Changes

  1. Say why you're proposing the changes, and then click on "Propose file change":
  • Make sure that you add a descriptive subject of what you have added

Step 5 - Propose file change

  1. Submit the pull request!

Step 6 - Start Pull Request

Step 6 - Confirm 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.