awesome-ipfs/CONTRIBUTING.md

# Contribution Guidelines

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.
- Review the [content policy](POLICY.md) to ensure your submission meets the requirements.

### 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.
- 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).

### 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.

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!
Initial setup 2015-10-14 13:35:45 -04:00			`# Contribution Guidelines`

			`Please ensure your pull request adheres to the following guidelines:`

Update CONTRIBUTING.md 2018-07-30 09:21:16 -04:00			`### 1. Before submitting`

Initial setup 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.`
feat: content policy (#150) 2019-11-15 17:49:09 -05:00			`- Review the [content policy](POLICY.md) to ensure your submission meets the requirements.`
Update CONTRIBUTING.md 2018-07-30 09:21:16 -04:00
			`### 2. Creating a submission`

Initial setup 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.`
on => in 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).
Update CONTRIBUTING.md 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.`
Initial setup 2015-10-14 13:35:45 -04:00
			`Thank you for your suggestions!`
feat: faster build via npm ci (#305) This adds package-lock.json to speed up install and the build. License: MIT Signed-off-by: Marcin Rataj <lidel@lidel.org> 2020-01-06 09:40:55 -05:00
			`-----`

Contributors no longer need to rebuild the readme before submitting PRs Thanks to https://github.com/ipfs/awesome-ipfs/pull/340 2020-04-20 05:36:44 -04:00			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!