Permalink
Browse files

Adjust contributing guidelines with regards to third party changes.

1 parent ac40284 commit 10035afad1358f4fafc90177de3fccf6fa9842dd @alienth alienth committed Oct 8, 2015
Showing with 2 additions and 1 deletion.
  1. +2 −1 CONTRIBUTING.md
View
@@ -8,7 +8,8 @@ Use GitHub pull requests to submit code. General submission guidelines:
1. Use `gofmt -s -w` and `go vet bosun.org/...`. See `build/validate.sh` for the full list of validation checks that will be run by Travis CI on each commit.
1. If using new third party packages, install party (`go get github.com/mjibson/party`) and run `party` in the root directory (`$GOPATH/src/bosun.org`) to vendor them and rewrite import paths.
-1. Squash all commits into one. This may be done as the final step before merging. Also the commit message should indicate what folder is being changed (example: `cmd/scollector: new xyz collector` or `docs: fix typo in window function`)
+1. Squash all non-`_third_party` commits into one. `_third_party` changes should be squashed down separately and precede any code changes which require them. This may be done as the final step before merging.
+1. The commit message should indicate what folder is being changed (example: `cmd/scollector: new xyz collector` or `docs: fix typo in window function`)
1. Documentation changes should be made in the same branch as code changes using the `docs` folder. After the PR is approved we will use the `build/docs/publish.go` script to publish the changes to the `gh-pages` branch. Please don't submit changes directly to the `gh-pages` branch, always use the docs folder.
Unless otherwise noted, the source files are distributed under the MIT license found in the LICENSE file.

0 comments on commit 10035af

Please sign in to comment.