1
0
Fork 0
mirror of https://github.com/ipfs/awesome-ipfs.git synced 2024-11-27 11:37:23 -05:00
ipfs/CONTRIBUTING.md

35 lines
1.5 KiB
Markdown
Raw Normal View History

2015-10-14 13:35:45 -04:00
# Contribution Guidelines
Please ensure your pull request adheres to the following guidelines:
2018-07-30 09:21:16 -04:00
### 1. Before submitting
2015-10-14 13:35:45 -04:00
- 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.
2019-11-15 17:49:09 -05:00
- Review the [content policy](POLICY.md) to ensure your submission meets the requirements.
2018-07-30 09:21:16 -04:00
### 2. Creating a submission
Make an individual pull request for each suggestion:
- **Do not edit README directly!**
- Add the idea to the corresponding file in [`data`](./data) and make sure it matches the format.
Style tips:
2015-10-14 13:35:45 -04:00
- 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.
2018-07-31 07:17:46 -04:00
- You can add a picture to describe your idea in [`./src/static/images`](./src/static/images).
2018-07-30 09:21:16 -04:00
### 3. Submitting it through a PR
- 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.
2015-10-14 13:35:45 -04:00
Thank you for your suggestions!
-----
**NOTE**: If you want to edit the README file directly (not the items/links) you need to modify the [`scripts/readme-template.md`](https://github.com/ipfs/awesome-ipfs/blob/master/scripts/readme-template.md) instead. Thank you!