Awesome-Mirrors/awesome-ipfs
1
0
Fork 0
mirror of https://github.com/ipfs/awesome-ipfs.git synced 2024-07-02 17:41:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Contributing Guidelines

Browse Source
This commit is contained in:
Henrique Dias 2018-07-18 10:53:09 +01:00 committed by GitHub
parent 88ccca1667
commit fbb0693680
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
CONTRIBUTING.md
View File

@ -5,16 +5,15 @@ Please ensure your pull request adheres to the following guidelines:
- 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.
- Make an individual pull request for each suggestion.
- Add the idea to [data][./data] and then run `node run build`.
- Use the following format: `[resource name](link) - Description.`
- 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.
- Make sure your text editor is set to remove trailing whitespace.
- The pull request should have a useful title and include a link to the package and why it should be included.
- If you are submitting an article, don't forget to include the date.
- 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).
- Make sure to run `node run build:readme` or `yarn build:readme` before submitting the Pull Request.
Thank you for your suggestions!