Skip to content

Commit

Permalink
Adjust the README with instructions for first time Gophers
Browse files Browse the repository at this point in the history
This commit adds instructions on how to checkout the code on your
computer and build.

This is needed to avoid friction with executing `got get` pointing to a
fork.

When a new contributor tries to `go get` from their fork, they will be
welcomed with an error message due to the import path still pointing to
the canonical project.

This commit adds the necessary information on how to checkout the
project and configure the remote as instructed by the community.
  • Loading branch information
bltavares committed Apr 4, 2017
1 parent 5061201 commit d6d0bc3
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,25 @@ add your name and email address to the
under the "Contributors" section using the format:
`First Last <[email protected]>`.

First, to setup the project, ensure that `$GOPATH` variable is pointing to an
existing directory, where all your Go code will be available.

After forking the repo on Github, run:

```sh
go get github.com/digitalocean/do-agent
cd $GOPATH/src/github.com/digitalocean/do-agent

git remote add my-fork <the url for your fork>
make test # ensure tests are passing
```

Push your changes to your fork:

```sh
git push -u master my-fork
```

Finally, submit a pull request for review!

## Report a bug
Expand Down

0 comments on commit d6d0bc3

Please sign in to comment.