These guidelines are referenced from awesome-quantified-self's contributing guidelines.
Please note that this project is released with a Contributor Code of Conduct, and is licensed by CC0 1.0 Universal.
By participating in this project you agree to abide by its terms.
To add something to the list, create a PR that adheres to the following guidelines:
- Search previous suggestions before making a new one, as yours may be a duplicate.
- For suggested packages, they should be tested and documented.
- Toy/ BATA (Build and throw away) projects are not allowed.
- Side projects are ok to be added if they help users to achieve a use case (they should be under Community Tools).
- For items, use the following format:
[resource](link) - Description. - Use title-casing (AP style).
- New categories, or improvements to the existing categorization are welcome.
- Additions should be added to the bottom of the relevant category.
- Link to the GitHub repo, not npmjs.com.
- Keep descriptions short and simple, but descriptive.
- Start the description with a capital and end with a full stop/period.
- Before you create the PR, install
awesome-lintand run it on your changes. This is a plugin created by the father of all awesome-lists. If your changes introduces new error(s) — please fix those before creating the PR. This helps the maintainer to reduce menial work. - The pull request should have a meaningful title and include a link to the package / resource and why it's awesome.
Thank you for your suggestions!