From fbb0693680977f2c920134b25c7aa84f31c799f4 Mon Sep 17 00:00:00 2001 From: Henrique Dias Date: Wed, 18 Jul 2018 10:53:09 +0100 Subject: [PATCH] Update Contributing Guidelines --- CONTRIBUTING.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fc429b7..24a83e2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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!