Skip to content

Commit 7a9f953

Browse files
authored
Create CONTRIBUTING.md
1 parent 98a8eab commit 7a9f953

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

CONTRIBUTING.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Contributing to Selenium Shutterbug
2+
3+
The Selenium Shutterbug project welcomes contributions from everyone.
4+
5+
### Step 1: Fork
6+
7+
Fork the project [on Github](https://github.com/assertthat/selenium-shutterbug)
8+
and check out your copy locally.
9+
10+
```text
11+
% git https://github.com/assertthat/selenium-shutterbug.git
12+
% cd selenium-shutterbug
13+
% git remote add upstream git://github.com/assertthat/selenium-shutterbug.git
14+
```
15+
### Step 2: Branch
16+
17+
Create a feature branch and start improving:
18+
19+
```text
20+
% git checkout -b my-feature-branch
21+
```
22+
23+
HEAD-based development is prefered, which means all changes are applied
24+
directly on top of master.
25+
26+
### Step 3: Commit
27+
28+
If you hve not configured Git already, its right time to do it, by specifying your name and email:
29+
30+
```text
31+
% git config --global user.name 'Your Name'
32+
% git config --global user.email 'name@example.com'
33+
```
34+
35+
Please read this before writing commit message:
36+
37+
http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
38+
39+
### Step 4: Rebase
40+
41+
Use `git rebase` (not `git merge`) to sync your work from time to time.
42+
43+
```text
44+
% git fetch upstream
45+
% git rebase upstream/master
46+
```
47+
48+
### Step 7: Push
49+
50+
```text
51+
% git push origin my-feature-branch
52+
```
53+
54+
Go to https://github.com/yourusername/selenium-shutterbug and press the _Pull
55+
Request_ and fill out the form.
56+
57+
You PR will be reviewed ASAP and integrated to master.

0 commit comments

Comments
 (0)