Community contributions are welcome and help move the project along. Please review this document before sending any merge requests.
Thanks!
This project is hosted on gitlab.com. Contributions are accepted only with merge requests on GitLab!
As a rule, merge requests that break existing functionalities are rejected. Feel free to challenge it, though.
All bug fixes are welcome. Please try to add a test if the bug is something that should have been fixed already. Oops.
New features are welcome provided that the feature has a general audience and is reasonably simple. The goal of the repository is to support a wide audience and be simple enough.
Please add new documentation in the docs folder for any new features. Merge requests for missing documentation are always welcomed. Keep the README.md focused on the most popular use cases, details belong in the docs directory.
If you want to implement a special feature, it will likely be accepted assuming you add the tests and follow the style guidelines below.
In an effort to not repeat bugs (and break less popular features), unit tests are run on GitLab CI. The goal of the tests are to be simple and to be placed in the test/tests directory where it will be automatically run. Review existing tests for an example.
The style of the repo follows that of the Linux kernel, in particular:
- Merge requests should be rebased to small atomic commits so that the merged history is more coherent
- The subject of the commit should be in the form "
<subsystem>: <subject>" - More details in the body
- Match surrounding coding style (line wrapping, spaces, etc)
More details in the SubmittingPatches document included with the Linux kernel. In particular the following sections:
2) Describe your changes3) Separate your changes