Skip to content

Latest commit

 

History

History
29 lines (19 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

29 lines (19 loc) · 1.93 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.

Ensure your pull request adheres to the following guidelines:

  • Use the following format: - [Resource Name](link) - Description.
  • Make sure you run linter: npx awesome-lint
  • And this as well: npx prettier --write README.md

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/donBarbos/awesome-standards
  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. Click on "Commit changes...". Step 4 - Click on "Commit changes..."
  6. Say why you're proposing the changes, and then click on "Commit changes". Step 5 - Propose Changes
  7. Submit the pull request!

Updating your PR

A lot of times, making a PR adhere to the standards above can be difficult. If the maintainers notice anything that we'd like changed, we'll ask you to edit your PR before we merge it. There's no need to open a new PR, just edit the existing one. If you're not sure how to do that, here is a guide on the different ways you can update your PR so that we can merge it.