- If the bug is a security vulnerability, please refer to the Security Policy
- Check if a solution is present in the Troubleshooting guide
- Check if the bug is already reported under Issues
- If there is no open issue addressing the problem, open a new one
Please open an issue with a high-level description of the change, to request feedback before submitting a pull request
- Make sure the PR only adds/changes/fixes a single thing
- Make sure the change does not break the test suite (by running
caringcaribou -i <INTERFACE> test) - Make sure the code adheres to PEP - 8 (Style Guide for Python Code)
- Avoid magic numbers in the code when possible
- Avoid changes that break other users' setups (such as dropping currently supported Python versions or hardcoding values for your favorite ECU)