Skip to content

Commit

Permalink
Fixed text in CONTRIBUTING.md (SeleniumHQ#3461)
Browse files Browse the repository at this point in the history
  • Loading branch information
Marketionist authored and mach6 committed Feb 6, 2017
1 parent bd8ac6d commit f8620f3
Showing 1 changed file with 18 additions and 17 deletions.
35 changes: 18 additions & 17 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ the defect. If the issue can't be reproduced it will be closed.
Please provide [concise reproducible test cases](http://sscce.org/)
and describe what results you are seeing and what results you expect.

Issues shouldn't be used for support. Please address questions to the
Issues shouldn't be used for support. Please address questions to the
[`selenium-users@` mailing list](https://groups.google.com/forum/#!forum/selenium-users).
Discussion of high level project ideas or non-technical topics should
move to the
Expand Down Expand Up @@ -66,7 +66,7 @@ This document will guide you through the contribution process.
Fork the project [on Github](https://github.com/seleniumhq/selenium)
and check out your copy locally.

```text
```shell
% git clone git@github.com:username/selenium.git
% cd selenium
% git remote add upstream git://github.com/seleniumhq/selenium.git
Expand All @@ -75,14 +75,15 @@ and check out your copy locally.
#### Dependencies

We bundle dependencies in the _third-party/_ directory that is not
part of the project proper. Any changes to files in this directory or
part of the proper project. Any changes to files in this directory or
its subdirectories should be sent upstream to the respective projects.
Please don't send your patch to us as we cannot accept it.

We do accept help in upgrading our existing dependencies or removing
superfluous dependencies. If you need to add a new dependency it's
often a good idea to reach out to the committers on the IRC channel or
the mailing list to check that your approach aligns with the project's
often a good idea to reach out to the committers on the
[IRC channel or the mailing list](https://github.com/SeleniumHQ/selenium/blob/master/CONTRIBUTING.md#communication)
to check that your approach aligns with the project's
ideas. Nothing is more frustrating than seeing your hard work go to
waste because your vision doesn't align with the project's.

Expand Down Expand Up @@ -119,7 +120,7 @@ file found in the top-level directory.

Create a feature branch and start hacking:

```text
```shell
% git checkout -b my-feature-branch
```

Expand All @@ -130,21 +131,21 @@ directly on top of master.

First make sure git knows your name and email address:

```text
```shell
% git config --global user.name 'Santa Claus'
% git config --global user.email 'santa@example.com'
```

**Writing good commit messages is important.** A commit message
should describe what changed, why, and reference issues fixed (if
any). Follow these guidelines when writing one:
any). Follow these guidelines when writing one:

1. The first line should be around 50 characters or less and contain a
short description of the change.
short description of the change.
2. Keep the second line blank.
3. Wrap all other lines at 72 columns.
4. Include `Fixes #N`, where _N_ is the issue number the commit
fixes, if any.
fixes, if any.

A good commit message can look like this:

Expand All @@ -170,7 +171,7 @@ run `git shortlog` or `git log --oneline`.

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

```text
```shell
% git fetch upstream
% git rebase upstream/master
```
Expand All @@ -182,13 +183,13 @@ see how they should be structured.

Before you submit your pull request make sure you pass all the tests:

```text
```shell
% ./go clean test
```

### Step 6: Sign the CLA

Before we can accept , we first ask people to sign a
Before we can accept, we first ask people to sign a
[Contributor License Agreement](https://spreadsheets.google.com/spreadsheet/viewform?hl=en_US&formkey=dFFjXzBzM1VwekFlOWFWMjFFRjJMRFE6MQ#gid=0)
(or CLA). We ask this so that we know that contributors have the right
to donate the code.
Expand All @@ -199,13 +200,13 @@ it.

### Step 7: Push

```text
```shell
% git push origin my-feature-branch
```

Go to https://github.com/yourusername/selenium.git and press the _Pull
Request_ and fill out the form. **Please indicate that you've signed
the CLA** (see step 6).
the CLA** (see Step 6).

Pull requests are usually reviewed within a few days. If there are
comments to address, apply your changes in new commits (preferably
Expand Down Expand Up @@ -240,11 +241,11 @@ The review labels (**R**) are:
* **blocked on external**: a change in an upstream repo is required
* **needs code changes**: waiting for you to fix a review issue
* **needs rebase**: the branch isn't in sync with master and needs to
be rebased
be rebased

Issues are labelled to make them easier to categorise and find by:

* which **component** they relate to (java, cpp, dotnet, py, rb)
* which **component** they relate to (java, cpp, dotnet, py, rb, nodejs)
* which **driver** is affected
* their presumed **difficulty** (easy, less easy, hard)
* what **type** of issue they are (defect, race condition, cleanup)
Expand Down

0 comments on commit f8620f3

Please sign in to comment.