Please include a summary of the proposed improvement or addressed issue.
Please describe your proposed improvement in English, this makes it consumable by others than the author.
If applicable you can provide a keyword to close/fix/resolve a related issue.
- Cosmetic change, clean up code without introducing new features or bugs, solely addressing issues related to code layout and style
- Bug fix (non-breaking change which fixes an issue)
- New feature (non-breaking change which adds functionality)
- Breaking change (fix or feature that would cause existing functionality to not work as expected)
- This change requires a documentation update
- Infrastructure change, changes to actions, CI, tool and configuration
Please delete options that are not relevant.
- My code follows the style guidelines of this project, please see the contribution guidelines.
- I have performed a self-review of my own code
- I have commented my code, particularly in hard-to-understand areas
- I have made corresponding changes to the documentation
- My changes generate no new warnings
- I have added tests that prove my fix is effective or that my feature works
- New and existing unit tests pass locally with my changes
- Any dependent changes have been merged and published in downstream modules
Please delete options that are not relevant.
You might think, that this is one crazy checklist, but it is just as much written for the maintainer of the involved software :-)