Contributing to this project should be as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
Github is used to host code, to track issues and feature requests, as well as accept pull requests.
Pull requests are the best way to propose changes to the codebase.
- Fork the repo and create your branch from
main. - If you've changed something, update the documentation.
- Make sure your code lints (using black or Ruff).
- Issue that pull request!
Report bugs using Github's issues
GitHub issues are used to track public bugs.
Report a bug by opening a new issue; it's that easy!
Great Bug Reports tend to have:
- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code if you can.
- Show logs
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
People love thorough bug reports. I'm not even kidding.
To enable, add this or modify the logging section of your Home Assistant configuration.yaml:
logger:
default: warning
logs:
custom_components.opnsense: debug