- Ensure the bug was not already reported by searching on GitHub under Issues.
- If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.
- Open a new GitHub pull request with the patch.
- Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
- Ensure that the PR code pass the GitHub automatic checks, you can use the following suggested workflow for be sure everything pass.
The best way for developing kci-dev is by using virtualenv and poetry
virtualenv .venv
source .venv/bin/activate
pip install poetry
poetry install
For executing the automated code checks
poe check
This checks can be automated during git commit
Just append poe check
to your pre-commit file
echo "poe check" >> .git/hooks/pre-commit