Thank you for your interest in contributing. This file provides an overview of the contribution workflow. Summary:
- Use Issues if you want to report a problem or want to see a feature.
- Create a pull requests (PR) to submit code.
- Send an email to the maintainer if you have something to discuss (no support requests).
If you spot a problem, have an idea or a feature request, search if an issue already exists. If a related issue doesn't exist, you can simply open a new issue.
As a general rule, we don't assign issues to anyone. If you find an issue to work on, you are welcome to open a pull request (PR) with a fix or feature. So if there is an existing issue you are interested in, just work on it. You might leave a comment there to inform others that there is work going on.
There is no public discussion or forum. If you have something to discuss or comment about the project, feel free to send an email to Andreas Haerter [email protected] (no support requests, all ressources are provided „as is“).
Make sure you read DEVELOPMENT.md, especially the encoding section. Make sure:
- That all source code or other components are compatible with the project's licensing and are traceable. Otherwise, we cannot accept your contribution.
- Your code is working / fix the problem / introduce a sane new feature.
- Your PR contains a proper commit message with a description of the change and reasoning.
Bonus: reference an issue (if any; PRs without an related issue are still welcome).
If you do not know how to open a PR, there is plenty of useful information around on the web. Github is also providing quite good documentation:
- Forking a repository so that you can make your changes without affecting the original project until we merge them.
- Branches
- Pull requests