Skip to content

Commit 6fde6d5

Browse files
author
Katrina Owen
committed
Simplify development instructions
1 parent 41aab7d commit 6fde6d5

File tree

1 file changed

+5
-17
lines changed

1 file changed

+5
-17
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,26 +12,15 @@ Exercism would be impossible without people like you being willing to spend time
1212

1313
You'll need Go version 1.11 or higher. Follow the directions on http://golang.org/doc/install
1414

15-
You will also need to be familiar with the Go `modules` dependency management system. Refer to the [modules wiki page](https://github.com/golang/go/wiki/Modules) to learn more.
16-
1715
## Development
1816

19-
A typical development workflow looks like this:
20-
21-
1. [fork this repo on the GitHub webpage][fork]
22-
1. `cd /path/to/the/development/directory`
23-
1. `git clone https://github.com/<your-github-username>/cli.git`
24-
1. `cd cli`
25-
1. `git remote add upstream https://github.com/exercism/cli.git`
26-
1. Optionally: `git config user.name <your-github-username>` and `git config user.email <your-github-email>`
27-
1. `git checkout -b <development-branch-name>`
28-
1. `git push -u origin <development-branch-name>` (setup where you push to, check it works)
29-
30-
Then make your desired changes and submit a pull request. Please provide tests for the changes where possible.
17+
This project uses Go's [`modules` dependency management](https://github.com/golang/go/wiki/Modules) system.
3118

32-
Please note that if your development directory is located inside the `GOPATH`, you would need to set the `GO111MODULE=on` environment variable, in order to be able to use the `modules` system.
19+
To contribute [fork this repo on the GitHub webpage][fork] and clone your fork.
20+
Make your desired changes and submit a pull request.
21+
Please provide tests for the changes where possible.
3322

34-
If you wish to learn how to contribute to the Go projects without the `modules`, check out the blog post [Contributing to Open Source Repositories in Go][contrib-blog] on the Splice blog.
23+
Please note that if your development directory is located inside the `GOPATH`, you need to set the `GO111MODULE=on` environment variable.
3524

3625
## Running the Tests
3726

@@ -66,4 +55,3 @@ In order to cross-compile for all platforms, run `bin/build-all`. The binaries
6655
will be built into the `release` directory.
6756

6857
[fork]: https://github.com/exercism/cli/fork
69-
[contrib-blog]: https://splice.com/blog/contributing-open-source-git-repositories-go/

0 commit comments

Comments
 (0)