First and foremost, thank you for the contribution! No matter what it is, a simple typo fix, a significant feature or a request for documentation, we value your effort a lot and want to thank you upfront.
The following guidelines should help you to improve the codebase. Note the wording "guidelines", not "rules", and use your best judgment.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
- Please write tests, especially when introducing new functionality or fixing bugs.
- Make sure you run all tests and read the compile-time and run-time warnings.
- Think about whether it would be better to document new code. When unsure, stay on the side of "write documentation". Specifically, code should be documented if for some reason (optimization, delicate concurrency behaviour etc.) it's not clear how it does what it does. The what should be derivable from class, method and variable names; if not, consider writing short documentation.
- Please stick to our coding style.
We welcome commit messages that explain the changes, the reasoning behind them and what parts of the system are affected. Conventional Commits are close to the targeted style, but deviations are possible.
We welcome new ideas, improvements and features. Please check first if a suggested improvement/PR already exists on the tracker. For both issues and PRs, the best way to communicate your wishes is to explain the use case and motivation first and the suggested steps afterwards.