Development

Descriptions and guides for the development of bitfl

Development Process

http://scottchacon.com/2011/08/31/github-flow.html

Make a change to master

1. If an Issue doesn't already exist, create an Issue referencing what you are working on.
2. Assign the Issue to yourself.
3. Create a new branch, with a name related to the issue.
4. Make a change.
5. Commit (using git commit -a). Use first line as a summary, then expand in later lines if necessary. Use "fixes #xyz" if relevant.
6. Make more changes if necessary, committing as you go to keep commits related.
7. Push back to origin
8. Open a pull request in the github web UI. Add notes for how to test these changes if possible.
9. Wait for someone to review your request, test the changes, and either comment or merge (if tests are verified).

How To

Setup git remote

$ git remote <url from github>

Create new branch

$ git checkout -b feature_branch

$ git push origin feature_branch

Update local copy of all branches

$ git fetch -p

• -p will 'prune', removing any local branch that does not exist on origin

Update a feature branch with latest master

$ git checkout master

$ git pull

$ git checkout feature_branch

$ git merge master

For any conflicts: http://git-scm.com/book/en/Git-Branching-Basic-Branching-and-Merging#Basic-Merge-Conflicts

Revert a commit

If you make a mistake and commit a change to the wrong branch, you can revert any commit:

http://stackoverflow.com/questions/4114095/git-revert-to-previous-commit-how

Automatically push any commits

To do this, you will need to edit the hook script that is executed on post-commit.

From the bitfl dir:

$ nano .git/hooks/post-commit

This should likely be empty, add the following contents:

#!/bin/sh

# This script will execute after a commit is complete

# Automatically push the changes back to origin

git push