Browse Source

Add simple contribution guidelines

Taken from sindresorhus/awesome.
Basix 2 years ago
1 changed files with 20 additions and 0 deletions
  1. +20

+ 20
- 0 View File

@@ -0,0 +1,20 @@
# Contribution Guidelines

## 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:
2. Click on the `` file: ![Step 2 Click on](
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.