Skip to content

Latest commit

 

History

History
17 lines (13 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

17 lines (13 loc) · 1.19 KB

Guidlines for contributing

We welcome contributions and development suggestions, which will be dealt with according to need and Analyst capacity at Public Health Scotland.

If you find a bug or performance issue, or want to request a feature please open an issue on GitHub. If you would like to develop the code please follow this best practice workflow:

  1. Fork the repository
  2. Checkout a new branch
  3. Update the code locally
  4. Add comments for other developers
  5. Add docstrings for code users
  6. Write tests to cover your updates
  7. Consider updating the documentation (see the documentation README)
  8. Commit and push changes to your fork
  9. Open a pull request to merge your branch into the main branch for Public-Health-Scotland/dose_instruction_parser
  10. Review tests and code coverage generated by GitHub actions (see the GitHub workflows readme)