mirror of
https://github.com/ipfs/awesome-ipfs.git
synced 2024-11-20 11:28:35 -05:00
Update CONTRIBUTING.md
This commit is contained in:
parent
e10ee74b87
commit
773864758e
1 changed files with 10 additions and 2 deletions
|
@ -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!
|
||||
|
|
Loading…
Reference in a new issue