Contributing¶
Get Involved¶
The KEBA KeEnergy API is an open-source project and contributions are welcome. You can:
- Report issues or request new features
- Improve documentation
- Contribute code
- Support the project by starring it on GitHub ⭐
Guidelines¶
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 for everything¶
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.
- Test you contribution.
- Issue that pull request!
Create a virtual environment¶
uv sync --all-extras --dev
Lint your code¶
uv run ruff check .
uv run mypy .
uv run yamllint .
uv run rumdl check .
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!
Write bug reports with detail, background, and sample code¶
Great Bug Reports tend to have:
- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code if you can
- 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.
Use a Consistent Coding Style¶
Use black to make sure the code follows the style.
uv run black .
Test your code modification¶
To test the code we use pytest:
uv run pytest -n auto
License¶
By contributing, you agree that your contributions will be licensed under its Apache License.