diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 61fb9d0..146d5e3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,25 +10,25 @@ Please ensure your pull request adheres to the following guidelines: ### 2. Creating a submission -- Make an individual pull request for each suggestion. +Make an individual pull request for each suggestion: +- **Do not edit README directly!** +- Add the idea to the corresponding file in [`data`](./data) and make sure it matches the format. + +Style tips: - 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 -- Make sure to run `npm ci && npm run 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! - - ----- -**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 and run `make build` again. Thank you! +**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! diff --git a/pull_request_template.md b/pull_request_template.md index fd92376..748d614 100644 --- a/pull_request_template.md +++ b/pull_request_template.md @@ -13,7 +13,6 @@ - [ ] This PR includes only one addition, removal, or edit. - [ ] I edited the `/data` directory instead of the [README.md](https://github.com/ipfs/awesome-ipfs/blob/master/README.md). -- [ ] I ran the `make build` command following my edits to the `/data` directory. - [ ] I reviewed the [content policy](https://github.com/ipfs/awesome-ipfs/blob/master/POLICY.md) and the and the [IPFS Community Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md) to ensure my submission meets the requirements. - [ ] I have followed the [CONTRIBUTING.md guidelines](https://github.com/ipfs/awesome-ipfs/blob/master/CONTRIBUTING.md).