Awesome-Mirrors/awesome-ipfs
1
0
Fork 0
mirror of https://github.com/ipfs/awesome-ipfs.git synced 2024-10-01 01:35:37 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #342 from ipfs/build-no-more

Browse Source 
Contributors no longer need to rebuild the readme before submitting PRs
This commit is contained in:
Andrew Nesbitt 2020-04-20 15:41:20 +01:00 committed by GitHub
commit a4fde39b02
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
CONTRIBUTING.md
View File

@ -10,25 +10,25 @@ Please ensure your pull request adheres to the following guidelines:
### 2. Creating a submission ### 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. - New categories, or improvements to the existing categorization are welcome.
- Keep descriptions short and simple, but descriptive. - Keep descriptions short and simple, but descriptive.
- Don't mention `IPFS` in the description as it's implied. - Don't mention `IPFS` in the description as it's implied.
- Start the description with a capital and end with a full stop/period. - Start the description with a capital and end with a full stop/period.
- Check your spelling and grammar. - 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). - You can add a picture to describe your idea in [`./src/static/images`](./src/static/images).
### 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!

1
pull_request_template.md
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).