awesome-ipfs/CONTRIBUTING.md

28 lines
1.3 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.
2018-07-30 09:21:16 -04:00
### 2. Creating a submission
2015-10-14 13:35:45 -04:00
- 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.
2018-07-31 07:17:46 -04:00
- Add the idea to the corresponding file in [`data`](./data) and make sure it matches the format.
- 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
- Make sure to run `npm run build:readme` or `yarn build:readme` before submitting the Pull Request.
2018-07-30 09:21:16 -04:00
- 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!