Contributing

By contributing to this project you agree to the release your code according to the license specified in the LICENSE file.

##Expectations This project uses Git and GitHub to manage all project code and issues. You must be familiar with both Git and GitHub in order to be an effective contributor. Please take the time to search for and read all relevant documentation on these tools before asking for help.

##Definitions

• upstream refers to the unfoldingWord-dev/ts-desktop repository.

##Start to Finish Contributing is very easy.

1. Fork this repository. See Fork a repo for instructions.
2. Follow the quick start guide in the README.
3. Use the git branching model.
4. Add a feature, fix a bug, or make something awesome.
5. Push your local branch to your fork.
6. Create a pull request. See Creating a pull request for instructions.

##Checklist Before you submit your code please check the following. Most of these can be easily determined from the command line. See the README for a list of commands.

• All unit tests pass.
• Your code passes the error check.
• Any new branches follow the git branching model.
• You have pulled in all updates from upstream. See Syncing a fork for instructions.

##Cloning Instructions If you are new to git or github all the cloning, branching, and forking can be confusing. Here is a quick step by step tutorial to help you set up your repositories.

1. Create a github account. Once you have an account you'll probably want to generate an ssh key so you don't have to enter your username and password each time you push your code to github. Read the Generating SSH Keys article for further instructions.
2. Fork this repository. See Fork a repo for instructions. You do not have permission to change this repository directly so you need to copy (fork) it.
3. Clone your fork. This will place a copy of your forked repository onto your computer where you will work on the code.
4. Add upstream as a remote. git remote add upstream https://github.com/unfoldingWord-dev/ts-desktop.git. This will allow you to pull updates from the upstream repository into your repository.