Skip to content

Commit 23178b3

Browse files
authored
docs: Remove go get from the recommended installation methods (roboll#437)
Add a contribution guide instead and note about the `go get` way there according to the discussion made in the relevant issue. Resolves roboll#393
1 parent fea6203 commit 23178b3

File tree

2 files changed

+39
-1
lines changed

2 files changed

+39
-1
lines changed

CONTRIBUTING.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# DCO + License
2+
3+
By contributing to `helmfile`, you accept and agree to the following DCO and license terms and
4+
conditions for your present and future Contributions submitted to the `helmfile` project.
5+
6+
[DCO](https://developercertificate.org/)
7+
[License](https://github.com/roboll/helmfile/blob/master/LICENSE)
8+
9+
# Developing helmfile
10+
11+
Locate your `GOPATH`, usually `~/go`, and run:
12+
13+
```console
14+
$ go get github.com/roboll/helmfile
15+
16+
$ cd $GOPATH/src/github.com/roboll/helmfile
17+
18+
$ git checkout -b your-shiny-new-feature origin/master
19+
20+
...
21+
22+
$ git commit -m 'feat: do whatever for whatever purpose
23+
24+
This adds ... by:
25+
26+
- Adding ...
27+
- Changing ...
28+
- Removing...
29+
30+
Resolves #ISSUE_NUMBER
31+
'
32+
33+
$ hub fork
34+
$ git push YOUR_GITHUB_USER your-shiny-new-feature
35+
$ hub pull-request
36+
```
37+
38+
Note that the above tutorial uses [hub](https://github.com/github/hub) just for ease of explanation.
39+
Please use whatever tool or way to author your pull request!

README.md

-1
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,6 @@ releases:
149149
150150
## installation
151151
152-
- `go get github.com/roboll/helmfile` or
153152
- download one of [releases](https://github.com/roboll/helmfile/releases) or
154153
- run as a [container](https://quay.io/roboll/helmfile) or
155154
- install from [AUR](https://aur.archlinux.org/packages/kubernetes-helmfile-bin/) for Archlinux or

0 commit comments

Comments
 (0)