🎉 First off, thanks for taking the time to contribute! 🎉
Contributing should be as easy as possible for anyone but there are a few things to keep in mind. The following guidelines for contribution should be followed if you want to submit a pull request.
- Make use of provided .editorconfig file.
- Make sure to have End of File new lines.
- Use 4 spaces for indentation.
- Make use of docblocks and comments.
- You need a GitHub account
- Submit an issue if there isn't one for the same matter yet.
- Describe the issue and include steps to reproduce if it's a bug.
- Ensure to mention the earliest version that you know is affected.
- If you are able and want to fix this, fork the repository on GitHub
-
In your forked repository, create a topic branch for your upcoming patch. (e.g.
feature--name)- Usually this is based on the master branch.
- Create a branch based on master;
git branch fix/master/my_contribution masterthen checkout the new branch withgit checkout fix/master/my_contribution. Please avoid working directly on themasterbranch.
-
Make sure you stick to the coding style that is used already.
-
Make use of the
.editorconfig-file if provided with the repository. -
Make commits of logical units and describe them properly.
-
Check for unnecessary whitespace with
git diff --checkbefore committing. -
If possible, submit tests to your patch / new feature so it can be tested easily.
-
Assure nothing is broken by running all the tests.
- Push your changes to a topic branch in your fork of the repository.
- Open a pull request to the original repository and choose the right original branch you want to patch.
Advanced users may install the
hubgem and use thehub pull-requestcommand. - If not done in commit messages (which you really should do) please reference and update your issue with the code changes. But please do not close the issue yourself. Notice: You can turn your previously filed issues into a pull-request here.