Help us make this project better by contributing, whether that be implementation of set features, bug fixes, adding to the test suite, or even enhancing our documentation. Please start with logging an issue to the issue tracker or submit a pull request.
Before you contribute, please review these guidelines to help ensure a smooth process for everyone.
Thank you!
- Please browse our existing issues before logging new issues.
- Open an issue with a descriptive title and a summary.
- Please be as clear and explicit as you can in your description of the problem.
- Please state the version of Operating System, Browser, and ASCVD Risk app you are using in the description.
- Include any relevant code in the issue summary.
- Read how to properly contribute to open source projects on Github
- Fork the project
- Use a feature branch.
- Write good commit messages.
- Use the same coding conventions as the rest of the project.
- Commit and push until you are happy with your contribution.
- Make sure to add tests and verify all the tests are passing when merging up.
- Add an entry to the Changelog accordingly.
- Please add your name to the CONTRIBUTORS.md file. Adding your name to the CONTRIBUTORS.md file signifies agreement to all rights and reservations by the License.
- Squash related commits together.
- Open a pull request.
- The pull request will be reviewed by the community and merged by the project committers.