Skip to content

Commit

Permalink
Fixed typos and updated repo url
Browse files Browse the repository at this point in the history
  • Loading branch information
sanbornm committed Sep 9, 2015
1 parent b7425ab commit 5a245e5
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
## Code of conduct
*Taken from http://libvirt.org/governance.html with minor adjustments.*

The open source community covers people from a wide variety of countries, backgrounds and positions. This global diversity is a great strength for this project, but can also lead to communication issues, which may in turn cause unhappiness. To maximise happiness of the project community taken as a whole, all members (whether users, contributors or committers) are expected to abide by the project's code of conduct. At a high level the code can be summarized as "be excellent to each other". Expanding on this:
The open source community covers people from a wide variety of countries, backgrounds and positions. This global diversity is a great strength for this project, but can also lead to communication issues, which may in turn cause unhappiness. To maximize happiness of the project community taken as a whole, all members (whether users, contributors or committers) are expected to abide by the project's code of conduct. At a high level the code can be summarized as "be excellent to each other". Expanding on this:

**Be respectful:** disagreements between people are to be expected and are usually the sign of healthy debate and engagement. Disagreements can lead to frustration and even anger for some members. Turning to personal insults, intimidation or threatening behaviour does not improve the situation. Participants should thus take care to ensure all communications / interactions stay professional at all times.
**Be respectful:** disagreements between people are to be expected and are usually the sign of healthy debate and engagement. Disagreements can lead to frustration and even anger for some members. Turning to personal insults, intimidation or threatening behavior does not improve the situation. Participants should thus take care to ensure all communications / interactions stay professional at all times.

**Be considerate:** remember that the community has members with a diverse background many of whom have English as a second language. What might appear impolite, may simply be a result of a lack of knowledge of the English language. Bear in mind that actions will have an impact on other community members and the project as a whole, so take potential consequences into account before pursuing a course of action.

Expand All @@ -24,20 +24,20 @@ Go is unlike any other language in that it forces a specific development workflo

### Prerequisites
* **Go**: To install Go please follow its installation guide at https://golang.org/doc/install
* **Git:**
* **Git:**
* **Debian-based distros:** `apt-get install git-core`
* **OSX:** `brew install git`

### Pull Requests
* Please be generous describing your changes.
* Although it is highly suggested to include tests, they are not a hard requirement in order to get your contributions accepted.
* Keep pull requets small so core developers can review them quickly.
* Although it is highly suggested to include tests, they are not a hard requirement in order to get your contributions accepted.
* Keep pull requests small so core developers can review them quickly.
* Unlike other projects, we are not going to nitpick your contributions. If your pull request is correct, we are going to merge and address the small details by ourselves. There is no point on delaying contributions due to little and unimportant details.

### Workflow for third-party code contributions
* In Github, fork `https://github.com/cloudescape/gowsdl` to your own account
* Get the package using "go get": `go get github.com/cloudescape/gowsdl`
* Move to where the package was cloned: `cd $GOPATH/src/github.com/cloudescape/gowsdl/`
* In Github, fork `https://github.com/hooklift/gowsdl` to your own account
* Get the package using "go get": `go get github.com/hooklift/gowsdl`
* Move to where the package was cloned: `cd $GOPATH/src/github.com/hooklift/gowsdl/`
* Add a git remote pointing to your own fork: `git remote add downstream git@github.com:<your_account>/gowsdl.git`
* Create a branch for making your changes, then commit them.
* Push changes to downstream repository, this is your own fork: `git push <mybranch> downstream`
Expand All @@ -48,7 +48,7 @@ Go is unlike any other language in that it forces a specific development workflo
### Workflow for core developers
Since core developers usually have access to the upstream repository, there is no need for having a workflow like the one for thid-party contributors.

* Get the package using "go get": `go get github.com/cloudescape/gowsdl`
* Get the package using "go get": `go get github.com/hooklift/gowsdl`
* Create a branch for making your changes, then commit them.
* Push changes to the repository: `git push origin <mybranch>`
* In Github, create the Pull Request from your branch to master.
Expand Down

0 comments on commit 5a245e5

Please sign in to comment.