Awesome-Mirrors/awesome-ipfs
1
0
Fork 0
mirror of https://github.com/ipfs/awesome-ipfs.git synced 2024-12-26 15:59:33 -05:00
Code Issues Packages Projects Releases Wiki Activity
cb3f9a5c50
awesome-ipfs/CONTRIBUTING.md
Marcin Rataj ce8b300ec1
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 15:40:55 +01:00

1.6 KiB
Raw Blame History

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 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 and make sure it matches the format.
  • You can add a picture to describe your idea in ./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 instead and run make build again. Thank you!