1
0
Fork 0
mirror of https://github.com/ipfs/awesome-ipfs.git synced 2024-11-20 11:28:35 -05:00

Contributors no longer need to rebuild the readme before submitting PRs

Thanks to https://github.com/ipfs/awesome-ipfs/pull/340
This commit is contained in:
Andrew Nesbitt 2020-04-20 10:36:44 +01:00
parent 584130d886
commit 7dabba3aa8
2 changed files with 1 additions and 5 deletions

View file

@ -21,14 +21,11 @@ Please ensure your pull request adheres to the following guidelines:
### 3. Submitting it through a PR ### 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. - 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. - 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! 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!

View file

@ -13,7 +13,6 @@
- [ ] This PR includes only one addition, removal, or edit. - [ ] 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 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 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). - [ ] I have followed the [CONTRIBUTING.md guidelines](https://github.com/ipfs/awesome-ipfs/blob/master/CONTRIBUTING.md).