Awesome-Mirrors/awesome-ipfs
1
0
Fork 0
mirror of https://github.com/ipfs/awesome-ipfs.git synced 2024-12-25 23:39:39 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
David Dias 2018-07-30 06:21:16 -07:00 committed by GitHub
parent e10ee74b87
commit 773864758e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
CONTRIBUTING.md
View File

@ -2,18 +2,26 @@
Please ensure your pull request adheres to the following guidelines:
### 1. Before submitting
- Search previous suggestions before making a new one, as yours may be a duplicate.
- If you just created something, wait at least a couple of weeks before submitting.
### 2. Creating a submission
- Make an individual pull request for each suggestion.
- New categories, or improvements to the existing categorization are welcome.
- Keep descriptions short and simple, but descriptive.
- Don't mention `IPFS` in the description as it's implied.
- Start the description with a capital and end with a full stop/period.
- Check your spelling and grammar.
- The pull request should have a useful title and include a link to the package and why it should be included.
- Submit products when they are useable, or at a state which has something to show which is awesome in itself. This cuts down on half-finished implementations.
- Add the idea to the corresponding file on [`data`](./data) and make sure it matches the format.
- You can add a picture to describe your idea on [`./src/static/images`](./src/static/images).
### 3. Submitting it through a PR
- Make sure to run `npm run build:readme` or `yarn build:readme` before submitting the Pull Request.
- The pull request should have a useful title and include a link to the package and why it should be included.
- Submit products when they are useable, or at a state which has something to show which is awesome in itself. This cuts down on half-finished implementations.
Thank you for your suggestions!