Skip to content

Instantly share code, notes, and snippets.

@dghubble
Last active Mar 9, 2019
Embed
What would you like to do?
Go CONTRIBUTING.md

Contributing

Thank you for considering contributing! There are many ways you can help.

Docs

Documentation and examples are extremely imporant. If you find an error, please send a fix. Contirbute forward for the times project docs/examples have helped.

Submit Patches

If you've found a bug, submit a patch as a pull request. Be sure to describe

  1. How can it be reproduced?
  2. What did you expect?
  3. What actually occurred?
  4. Versions, platform, etc.

Tips:

  • Go code must be fmt'd, lint'ed, and vet'd. See Makefile.
  • Include tests to improve coverage and prevent regressions.
  • Squash changes into a single commit per feature/fix.
  • Write good commit messages, in the present tense! (Add X, not Added X).
    • Short title, blank line, bullet points if needed.
    • Capitalize the first letter of the title or bullet item.
    • No punctuation in the title.

Conduct

All are welcome. See the Go Code of Conduct.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment