Everything you need to know to contribute efficiently to the project.
This project uses the following integrations to ensure proper codebase maintenance:
- CircleCI - run jobs for package build and coverage
- Codacy - analyzes commits for code quality
- Codecov - reports back coverage results
As a contributor, you will only have to ensure coverage of your code by adding appropriate unit testing of your code.
## Issues
Use Github issues for feature requests, or bug reporting. When doing so, use issue templates whenever possible and provide enough information for other contributors to jump in.
## Developping torchcam
- Code: ensure to provide docstrings to your Python code. In doing so, please follow Google-style so it can ease the process of documentation later.
- Commit message: please follow Udacity guide