add instructions for local development #140
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rbren
reviewed
Jun 7, 2019
CONTRIBUTING.md
Outdated
|
|
||
| ### Installation | ||
| * Install the project with `go get github.com/reactiveops/polaris` | ||
| * Change into the polaris directory which is installed at `~/go/src/github.com/reactiveops/polaris` |
There was a problem hiding this comment.
More generically, it's at $GOPATH/src/github.com/reactiveops/polaris
|
Thanks Kim! This is super helpful. Here's a link to the CLA: https://cla-assistant.io/reactiveops/polaris Looks good otherwise! |
rbren
approved these changes
Jun 7, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does and why we need it
This PR adds instructions for how to run Polaris locally so people can setup the project on their computer. This will lower the barrier to entry for contributors that are outside of ReactiveOps.
Please note
I had to sign a CLA in order to work on the project, but I cannot find a link for it, so the 'Contributor License Agreement' url is blank. Please let me know where I can find that info.