You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1.7 KiB
1.7 KiB
How to contribute
Contributions are always welcome. There are several ways to help out:
- Create an issue on GitHub, if you have found a bug
- Write test cases or provide examples for open bug issues
- Write patches for open bug/feature issues
There are a few guidelines that we need contributors to follow so that we have a chance of keeping on top of things.
Getting Started
- Make sure you have a GitHub account.
- Submit an issue, assuming one does not already exist.
- Clearly describe the issue including steps to reproduce when it is a bug.
- Make sure you fill in the earliest version that you know has the issue.
- Fork the repository on GitHub.
Making Changes
- Create a topic branch from where you want to base your work.
- This is usually the master branch.
- Only target release branches if you are certain your fix must be on that branch.
- To quickly create a topic branch based on master;
git branch master/my_contribution masterthen checkout the new branch withgit checkout master/my_contribution. Better avoid working directly on themasterbranch, to avoid conflicts if you pull in updates from origin.
- Make commits of logical units.
- Check for unnecessary whitespace with
git diff --checkbefore committing. - Use descriptive commit messages and reference the #issue number.
Submitting Changes
- Push your changes to a topic branch in your fork of the repository.
- Submit a pull request to the repository
Editor Config
The project uses .editorconfig to define the coding style of each file. We recommend that you install the Editor Config extension for your preferred IDE.