You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+16-21Lines changed: 16 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,33 +10,28 @@ Exercism would be impossible without people like you being willing to spend time
10
10
11
11
## Dependencies
12
12
13
-
You'll need Go version 1.10 or higher. Follow the directions on http://golang.org/doc/install
13
+
You'll need Go version 1.11 or higher. Follow the directions on http://golang.org/doc/install
14
14
15
-
You will also need `dep`, the Go dependency management tool. Follow the directions on https://golang.github.io/dep/docs/installation.html
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
16
17
17
## Development
18
18
19
-
If you've never contributed to a Go project before this is going to feel a little bit foreign.
20
-
21
-
The TL;DR is: **don't clone your fork**, and it matters where on your filesystem the project gets cloned to.
22
-
23
-
If you don't care how and why and just want something that works, follow these steps:
19
+
A typical development workflow looks like this:
24
20
25
21
1.[fork this repo on the GitHub webpage][fork]
26
-
1.`go get github.com/exercism/cli/exercism`
27
-
1.`cd $GOPATH/src/github.com/exercism/cli` (or `cd %GOPATH%\src\github.com\exercism\cli` on Windows)
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.
36
31
37
-
Then make changes as usual and submit a pull request. Please provide tests for the changes where possible.
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.
38
33
39
-
If you care about the details, check out the blog post [Contributing to Open Source Repositories in Go][contrib-blog] on the Splice blog.
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.
40
35
41
36
## Running the Tests
42
37
@@ -56,12 +51,12 @@ damaging your real Exercism submissions, or test different tokens, etc.
56
51
57
52
On Unices:
58
53
59
-
-`cd $GOPATH/src/github.com/exercism/cli/exercism && go build -o testercism main.go`
54
+
-`cd /path/to/the/development/directory/cli && go build -o testercism main.go`
0 commit comments