From 23178b398ce4bd8cdbca90f087f7120355085461 Mon Sep 17 00:00:00 2001 From: KUOKA Yusuke Date: Thu, 17 Jan 2019 12:03:58 +0900 Subject: [PATCH] docs: Remove `go get` from the recommended installation methods (#437) Add a contribution guide instead and note about the `go get` way there according to the discussion made in the relevant issue. Resolves #393 --- CONTRIBUTING.md | 39 +++++++++++++++++++++++++++++++++++++++ README.md | 1 - 2 files changed, 39 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..54e996af --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,39 @@ +# DCO + License + +By contributing to `helmfile`, you accept and agree to the following DCO and license terms and +conditions for your present and future Contributions submitted to the `helmfile` project. + +[DCO](https://developercertificate.org/) +[License](https://github.com/roboll/helmfile/blob/master/LICENSE) + +# Developing helmfile + +Locate your `GOPATH`, usually `~/go`, and run: + +```console +$ go get github.com/roboll/helmfile + +$ cd $GOPATH/src/github.com/roboll/helmfile + +$ git checkout -b your-shiny-new-feature origin/master + +... + +$ git commit -m 'feat: do whatever for whatever purpose + +This adds ... by: + +- Adding ... +- Changing ... +- Removing... + +Resolves #ISSUE_NUMBER +' + +$ hub fork +$ git push YOUR_GITHUB_USER your-shiny-new-feature +$ hub pull-request +``` + +Note that the above tutorial uses [hub](https://github.com/github/hub) just for ease of explanation. +Please use whatever tool or way to author your pull request! diff --git a/README.md b/README.md index 39f7759b..b7ef2294 100644 --- a/README.md +++ b/README.md @@ -149,7 +149,6 @@ releases: ## installation -- `go get github.com/roboll/helmfile` or - download one of [releases](https://github.com/roboll/helmfile/releases) or - run as a [container](https://quay.io/roboll/helmfile) or - install from [AUR](https://aur.archlinux.org/packages/kubernetes-helmfile-bin/) for Archlinux or