Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
58 lines (38 sloc) 1.34 KB

Contributing to Selenium Shutterbug

The Selenium Shutterbug project welcomes contributions from everyone.

Step 1: Fork

Fork the project on Github and check out your copy locally.

% git clone https://github.com/username/selenium-shutterbug.git
% cd selenium-shutterbug
% git remote add upstream https://github.com/assertthat/selenium-shutterbug.git

Step 2: Branch

Create a feature branch and start improving:

% git checkout -b my-feature-branch

HEAD-based development is prefered, which means all changes are applied directly on top of master.

Step 3: Commit

If you hve not configured Git already, its right time to do it, by specifying your name and email:

% git config --global user.name 'Your Name'
% git config --global user.email 'name@example.com'

Please read this before writing commit message:

http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

Step 4: Rebase

Use git rebase (not git merge) to sync your work from time to time.

% git fetch upstream
% git rebase upstream/master

Step 7: Push

% git push origin my-feature-branch

Go to https://github.com/yourusername/selenium-shutterbug and press the Pull Request and fill out the form.

You PR will be reviewed ASAP and integrated to master.