All contributions require a review from the code owners.
The project uses several formatters and linters. poetry and pre-commit-hooks are used to manage and execute those.
When contributing code, please make sure to execute the checks.
After you have installed poetry for your platform install the tools required by DWYU: poetry install.
Then, you can execute all relevant checks via poetry run pre-commit run --all-files or configure pre-commit-hooks to run automatically for each commit.
Most of the markdown stile is automatically enforced with mdformat. Some part is however maintained manually:
- Each sentence starts in a new line.
- Sentences are not wrapped, no matter how long they are.
<br>is used to enforce a newline.
Please make sure you are aware of the known limitations.
Please introduce a minimal example for reproducing the bug. Ideally as a test case, but any minimal example helps.
- Please create an issue before changing features or introducing new features. Discussing your idea first makes sure it is in the interest of the project and your work will not be in vain due to following an undesired direction.
- Make sure you are aware of the existing design rationales.
- No feature shall be changed or introduced without adapting or adding tests accordingly.
Feel free to directly create pull requests without creating an issue for small improvements like fixing typos.