diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 48 |
1 files changed, 14 insertions, 34 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 55e7174..57d01c2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,13 +19,10 @@ to both users inside and outside of WMF and our communities. 2. `dep` for dependency management * On macOS, try Homebrew: `brew install dep` * [Other](https://golang.github.io/dep/docs/installation.html) - 3. `arcanist` for code review - * See our [help article](https://www.mediawiki.org/wiki/Phabricator/Arcanist) - for setup instructions. - 4. An account at [phabricator.wikimedia.org](https://phabricator.wikimedia.org) - * See our [help article](https://www.mediawiki.org/wiki/Phabricator/Help) - for setup instructions. - 5. (optional) `gox` is used for cross-compiling binary releases. To + 3. An account at [gerrit.wikimedia.org](https://gerrit.wikimedia.org) + * See the [guide](https://www.mediawiki.org/wiki/Gerrit/Getting_started) + on mediawiki.org for setup instructions. + 4. (optional) `gox` is used for cross-compiling binary releases. To install `gox` use `go get github.com/mitchellh/gox`. ## Get the source @@ -33,28 +30,21 @@ to both users inside and outside of WMF and our communities. Use `go get` to install the source from our Git repo into `src` under your `GOPATH`. By default, this will be `~/go/src`. - go get phabricator.wikimedia.org/source/blubber + go get gerrit.wikimedia.org/r/blubber Symlink it to a different directory if you'd prefer not to work from your `GOPATH`. For example: cd ~/Projects - ln -s ~/go/src/phabricator.wikimedia.org/source/blubber + ln -s ~/go/src/gerrit.wikimedia.org/r/blubber cd blubber # yay. -## Initialize submodules in `.arcvendor` - -We currently use a submodule for integrating Go testing tools into Arcanist -which will run automatically upon submission to Differential via `arc diff`. - - git submodule update --init - ## Have a read through the documentation If you haven't already seen the [README.md](README.md), check it out. Run `godoc -http :9999` and peruse the HTML generated from inline docs -at `localhost:9999/pkg/phabricator.wikimedia.org/source/blubber`. +at `localhost:9999/pkg/gerrit.wikimedia.org/r/blubber`. ## Installing or updating dependencies @@ -70,30 +60,20 @@ If you do update `Gopkg.toml` to add, update, or remove a dependency, simply run `dep ensure && dep prune` after doing so, and commit the resulting `vendor` directory changes. - ## Running tests Tests and linters for packages/files you've changed will automatically run -when you submit your changes to Differential via `arc diff`. You can also do -this manually. +when you submit your changes to Gerrit for review. You can also run tests +locally by running `go test`. - arc unit # or - arc unit --everything # or simply - go test ./... # or + go test ./... # for everything, or go test -run TestFuncName ./... # to run a single test - arc lint # or - arc lint --everything - -## Getting your changes reviewed - -Use `arc diff` to submit your changes to Differential. - - -## Landing your changes +## Getting your changes reviewed and merged -Once your changes have been accepted, run `arc land` on your local branch to -merge/push the commit and close the diff. +Push your changes to Gerrit for review. See the +[guide](https://www.mediawiki.org/wiki/Gerrit/Tutorial#How_to_submit_a_patch) +on mediawiki.org on how to correctly prepare and submit a patch. ## Releases |