Thank you for your interest in contributing to this project. From commenting on issues, to reviewing and sending Pull Requests, all contributions are welcome.
The Open Source Guides website has a collection of resources for anyone who wants to learn how to contribute to open source projects, along with a lot of other valuable information on open source.
As a reminder, all contributors are expected to adhere to the Code of Conduct.
- Contribute fixes, improvements and documentation
- Replying to and assisting with open issues
- Reviewing pull requests
- Provide improved test data
- Clinical analysis of results, and identification of gaps
We use GitHub issues and pull requests to track bugs and contributions from the community, including Practice Fusion engineers. All changes are handled through pull requests, and before they are approved, the changes must meet the standards outlined in the Contributing Code section below, including a review by Practice Fusion clinicians if there are any changes that might affect the clinical nature of the calculation results.
Changes to the grammar require care and a lot of testing. Please follow the guidelines when planning and developing grammar changes.
Code coverage is generated using Coverlet. We aim for more than 90% coverage, with the exclusions documented in the coverlet runsettings file.
We use MinVer.
Code-level contributions must be made through pull requests. This is done by forking the repository, making the changes locally, and using the testing projects to validate the changes you've made.
We recommend using the following workflow:
- Fork the repository and create a branch from dev
- Make your changes, and add tests for your changes (see the section on Testing above)
- For any changes to APIs, update the documentation in the code
- Make sure all tests pass
- Make sure your code meets the code standards in
.editorconfig - Push the changes to your fork
- Create a pull request to the Calculator repository
- Review and address comments on your pull request