Forking and Contributing to Bricklayer

If you are interested in contributing to Bricklayer, or want to join the team, you must fork our project and push some useful changes back to us. Please make sure you brush up on the basics of Git and GitHub before contributing.

If your interested in basing your own project off of Bricklayer instead, that is great, just remember to follow the guidelines in our LICENSE.txt file. Essentially you may do whatever you want with the source, provided that you keep your application or modified version free, and open source, just like us.

##Step 1: Forking & Cloning

Follow the instructions found in this GitHub tutorial to fork and clone the Bricklayer repository.

Take note of how to push changes to us when you are done, and how to update your fork with new changes that we make.

##Step 2: Editing, Pushing and Submitting a Pull Request

Find something you would like to work on, weather it is a bug fix, or a new feature (Within reason for the project)

After you have navigated to your fork, create a new branch for your feature by typing into your Git console: git checkout -b featurename Where featurename, is a short name of your feature. Creating a branch like this allows you to work on multiple things at once, and will help us greatly if we accept your pull request.

You can now work on this branch and implement your feature or fix. Type git commit to commit any changes.

When you are done with your editing, you may have multiple commits ready to push to us. First, push them to your own fork with git push origin master

Then, you may push the change to us through a pull request. Check out this GitHub tutorial on pull requests.

We may accept, decline, or ask for further changes to your request when we receive and review it.

Helping contribute makes this a nice open source project, and we thank you for your work!