Workflow

Contributions Workflow

In order to contribute for the Catrobat Project, please use the following workflow:

Setup

1. Fork the official repository
2. Clone it to your local machine via git clone YOUR_FORKED_REPOSITORY_URL
3. Setup upstream to keep repository up to date: git remote add upstream URL_TO_OFFICIAL_REPOSITORY
   Example: git remote add upstream https://github.com/Catrobat/Catroid.git
4. To update your repository use: git pull upstream BRANCH
   Example: git pull upstream development

NOTE: upstream defines the official repository and origin your forked repository!

Make your contribution

1. Please make your contributions on your local machine
2. Commit them: git commit -am "My Contribution"
3. If you have to rebase - use git rebase BRANCH where BRANCH is the target branch where the changes should be added. If you want more information about rebasing, please visit: http://git-scm.com/book/de/v1/Git-Branching-Rebasing
4. If you have more than one commit, create a new branch and squash your commits into it: git merge --squash
5. Push your contribution to your forked repository: git push origin BRANCH

Make a Pull Request

1. Visit your github site and open the forked repository
2. Create a pull request by pressing the green button beside the branch selection field
3. Select the source and target of the pull request
   Example: base fork: Catrobat/Catroid base:development ---- head fork: USER/Catroid compare:development
4. Send the pull request

THANKS for your contribution

NOTE: nice git tutorial: https://try.github.io