Skip to content

Latest commit

 

History

History
55 lines (44 loc) · 2.31 KB

CONTRIBUTING.md

File metadata and controls

55 lines (44 loc) · 2.31 KB
Raw

Thank you for contributing. These are some general guidelines for your contributions and communications in this repository:

Issues

Thank you for reporting an issue. To make dealing with them as simple as possible, please consider the following things:

  • Choose an expressive and meaningfull title to describe the problem.

For bugs:

  • Describe the bug roughly. Give observed and expected behavior. If applicable, attach relevant logs.
  • Create a minimum working example for reproducing the bug as either a gist, a go playground share or in some other online form. This minimum working example should be gofmt'ed.

For feature-requests:

  • Describe the usecase you intend to solve.

Pull-Requests

First of all, thank you for contributing code :) We try to have relatively high standards on readability and maintainability and we are relatively opinionated about certain things. This means, that your PR is likely to take a couple of iterations to get accepted. We appreciate your patience with this :)

Please make sure, the following is true, when you submit your PR:

  • In the end, your PR should be treated as getting submitted as a single commit. In particular, this means that your PR should only contain changes, that make sense as a commit. If you want to make more than one independent change, please submit multiple PRs.
  • All .go code is gofmt, go vet and golint clean. If you think that a particular warning by go vet or golint is not usefull, please mention this in the description of your pull request (not the commit-message).
  • Please be aware, that code you are submitting as a PR will be put under the license of this repository.

Coding Style

General coding style is idiomatic go. Readability has priority. You might take into account this list of resources. You don't need to know them all, though. They will be pointed out to you in the review process.

Conduct

In general, we expect respectfull conduct. If the go code of conduct is already published when you read this, you should apply it to your communications in regards to this Repository. Otherwise, you might use the Django Code of Conduct as a rough guideluine.