Skip to content
This repository has been archived by the owner on Oct 24, 2023. It is now read-only.

Latest commit

 

History

History
59 lines (40 loc) · 2.24 KB

CONTRIBUTING.md

File metadata and controls

59 lines (40 loc) · 2.24 KB

Contributing

General code rules

For docstrings we're following Effective Go - Commentary

All methods meant to be used by end-user must be documented - no exceptions!

Other code quality metrics are measured as well via Go Report Card

Naming conventions

Please try to follow Style guideline for Go packages and Package names

Submitting a pull request

Before you submit your pull request consider the following guidelines:

  • Fork the repository and clone your fork

  • Make your changes in a new git branch:

    git checkout -b bug/my-fix-branch master
  • Create your patch, ideally including appropriate test cases

  • Include documentation that either describe a change to a behavior or the changed capability to an end user

  • Commit your changes using a descriptive commit message. If you are fixing an issue please include something like 'this closes issue #xyz'

    • Please make sure your tests pass!
    • Currently we use Travis CI for our automated testing.
  • Push your branch to GitHub:

    git push origin bug/my-fix-branch
  • When opening a pull request, select the master branch as a base.

  • Mark your pull request with [WIP] (Work In Progress) to get feedback but prevent merging (e.g. [WIP] Update CONTRIBUTING.md)

  • If we suggest changes then:

    • Make the required updates

    • Push changes to git (this will update your Pull Request):

      • You can add new commit
      • Or rebase your branch and force push to your GitHub repository:
      git rebase -i master
      git push -f origin bug/my-fix-branch

That's it! Thank you for your contribution!