Contributing to bosun and scollector
Bosun and scollector are open source projects. We appreciate your help.
Use GitHub pull requests to submit code. General submission guidelines:
gofmt -s -wand
go vet bosun.org/.... See
build/validate.shfor the full list of validation checks that will be run by Travis CI on each commit.
- If using new third party packages, install party (
go get github.com/mjibson/party) and run
partyin the root directory (
$GOPATH/src/bosun.org) to vendor them and rewrite import paths.
- Squash all non-
_third_partycommits into one.
_third_partychanges should be squashed down separately and precede any code changes which require them. This may be done as the final step before merging.
- The commit message should indicate what folder is being changed (example:
cmd/scollector: new xyz collectoror
docs: fix typo in window function)
- Documentation changes should be made in the same branch as code changes using the
docsfolder. After the PR is approved we will use the
build/docs/publish.goscript to publish the changes to the
gh-pagesbranch. Please don't submit changes directly to the
gh-pagesbranch, always use the docs folder.
Unless otherwise noted, the source files are distributed under the MIT license found in the LICENSE file.
We use the golang Go Code Review Comments document as the basis for our style. Take particular note of Error Strings, Mixed Caps, and Indent Error Flow sections. Also we don't have blank lines within functions.
bosun submission guidelines
- If changing HTML, JS, or other static content, install esc (
go get github.com/mjibson/esc), then run
- typescript is required if changing JS files. Invoke bosun with
-wto watch for
.tschanges and automatically run typescript.