Contributions are essential for keeping this Open-Source Project alive. We want to keep it as easy as possible to contribute changes that get things working in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.
- Make sure you have a GitHub account.
- Submit your issue if 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.
- 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, run
git checkout -b fix/master/my_contribution master. Please avoid working directly on themasterbranch.
- Make commits of logical and atomic units.
- Check for unnecessary whitespace with
git diff --checkbefore committing. - Make sure your commit messages are in the proper format. If the commit addresses an filed issue add a reference to that issue in your commit message.
- Make sure you have added the necessary tests for your changes.
- Push your changes to a topic branch in your fork of the repository.
- Submit a pull request to the repository main repository.
- Update your github issue to mark that you have submitted code and are ready for it to be reviewed.
- At this point you're waiting on us. We may suggest some changes or improvements or alternatives and accept the pull request when everything is ok.
Some things that will increase the chance that your pull request is accepted:
- Write tests.
- Write a good commit message.