8d72177671
Complete the English API translation started in #675: - rename input fields pv_akku to pv_battery and eauto to ev, and the solution fields eautocharge_hours_float to ev_charge_hours_float and eauto_obj to ev_obj; the German names are still accepted on input via validation aliases and re-emitted in responses as deprecated computed fields, same pattern as #675 - mark the legacy endpoints /strompreis, /gesamtlast and /gesamtlast_simple as deprecated in the OpenAPI schema - use amount instead of a euro reference in the battery LCOS log message Co-authored-by: Tobias Welz <tobias.wizneteu@gmail.com>
2.7 KiB
Contributing to EOS
Thanks for taking the time to read this!
The EOS project is in early development, therefore we encourage contribution in the following ways:
Documentation
Latest development documentation can be found at Akkudoktor-EOS.
Bug Reports
Please report flaws or vulnerabilities in the GitHub Issue Tracker using the corresponding issue template.
Ideas & Features
Issues in the GitHub Issue Tracker are also fine to discuss ideas and features.
You may first discuss the idea in the Akkudoktor Forum before opening an issue.
Code Contributions
We welcome code contributions and bug fixes via Pull Requests. To make collaboration easier, we require pull requests to pass code style, unit tests, and commit message style checks.
Setup development environment
Setup virtual environment, then activate virtual environment and install development dependencies.
python -m venv .venv
source .venv/bin/activate
pip install -r requirements-dev.txt
pip install -e .
Install make to get access to helpful shortcuts (documentation generation, manual formatting, etc.).
-
On Linux (Ubuntu/Debian):
sudo apt install make -
On MacOS (requires Homebrew):
brew install make
The server can be started with make run. A full overview of the main shortcuts is given by make help.
Code Style
All code, comments, docstrings, identifiers and API field names are written in English.
Our code style checks use pre-commit.
To run formatting automatically before every commit:
pre-commit install
pre-commit install --hook-type commit-msg --hook-type pre-push
Or run them manually:
pre-commit run --all-files
Tests
Use pytest to run tests locally:
python -m pytest -vs --cov src --cov-report term-missing tests/
Commit message style
Our commit message checks use
commitizen. The checks
enforce the Conventional Commits commit message style.
You may use commitizen also to create a
commit message and commit your change.
Thank you!
And last but not least thanks to all our contributors