Contributing Code

GitHub flow

If you're not yet familiar with the way GitHub works (forking, pull requests, etc.), be sure to check out the awesome article about forking on the GitHub Help website — it will get you started quickly.

Contributing Code

• Create a personal fork of the project on GitHub.

• Clone the fork on your local machine. Your remote repo on GitHub is called origin.

• Add the original repository as a remote called upstream.

• If you created your fork a while ago be sure to pull upstream changes into your local repository.

• Create a new branch to work on! Branch from master.

  You should always write each batch of changes (feature, bugfix, etc.) in its own topic branch.

  Please do not commit to the master branch, or your unrelated changes will go into the same pull request.

• Implement/fix your feature, comment your code.

• Follow the code style of the project, including indentation.

• Add or change the documentation as needed.

• Squash some commits into a single commit if necessary.

• Push your branch to your fork on GitHub, the remote origin.

• From your fork open a pull request in the correct branch. Target the project's master branch!

• …

• If the maintainer requests further changes just push them to your branch. The PR will be updated automatically.

• Once the pull request is approved and merged you can pull the changes from upstream to your local repo and delete your extra branch(es).

And last but not least: follow our commit messages style:

• Start message with some keyword describing it's scope ("IITC-Mobile: …", "draw-tools: …")
• Follow good practices, e.g. these seven rules.
• If it seems difficult to summarize what your commit does, it may be because it includes several logical changes or bug fixes, and are better split up into several commits using git add -p.