cffdb06181
While writing docs, I couldn't remember what the correct style was supposed to be, and I remember someone complaining about this previously, so I decided to add a linter! I excluded a bunch of annoying style rules, but if we find more we can add those to the list too. Hopefully this gives us a more consistent feel throughout.
1.1 KiB
1.1 KiB
Tips:
-
please read the style guide before submitting your patch: docs/style-guide.md
-
commit message titles must be in the form:
topic: Capitalized message with no trailing period
or:
topic, topic2: Capitalized message with no trailing period
- golang code must be formatted according to the standard, please run:
make gofmt # formats the entire project correctly
or format a single golang file correctly:
gofmt -w yourcode.go
- please rebase your patch against current git master:
git checkout master
git pull origin master
git checkout your-feature
git rebase master
git push your-remote your-feature
hub pull-request # or submit with the github web ui
- after a patch review, please ping @purpleidea so we know to re-review:
# make changes based on reviews...
git add -p # add new changes
git commit --amend # combine with existing commit
git push your-remote your-feature -f
# now ping @purpleidea in the github PR since it doesn't notify us automatically