Skip to content

Latest commit

 

History

History
41 lines (26 loc) · 1.94 KB

contributing.md

File metadata and controls

41 lines (26 loc) · 1.94 KB

Contribution Guidelines

What

  • Standalone features for web.
  • Can be free or paid.
  • Use the following format: [package](link) - Description of new item.
  • Watch for casing and spelling.
  • Describe what the tool is doing. No marketing slogans. E.g. instead of "Create XYZ", use "[Kind of tool] to create XYZ". Avoid marketing words such as: easy, simple, beautiful, premium, powerful, amazing.
  • Avoid subjective words like "smaller", "bigger".
  • Avoid starting with "A" or "An".
  • Avoid using "your" (e.g. "for your website" => "for websites", "back to your website" => "back to the website").
  • Avoid numbers, they will get outdated.
  • Keep consistent tech spelling: JavaScript, React, Vue, Angular.

How

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/componently-com/awesome-building-blocks-for-web
  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

  1. You can start editing the text of the file in the in-browser editor. You can use GitHub Flavored Markdown.

Step 4 - Edit the file

  1. If you update categories run: npx doctoc --title '## Contents' README.md

  2. Say why you're proposing the changes, and then click on "Propose file change".

Step 6 - Propose Changes

  1. Submit the pull request!