Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 2.31 KB

CONTRIBUTING.md

File metadata and controls

49 lines (33 loc) · 2.31 KB

Contributing to dt

At first: Thank you for contributing to dt! 🎉 :octocat:

Table Of Contents

Code of Conduct How can I contribute?

Code of Conduct

This project and everyone participating in it is governed by the Developer-Toolbelt Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to ch.claus@me.com.

How can I contribute?

Reporting bugs

Bugs are tracked as GitHub issues. Please explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Use error logs if possible. If there are some error logs, please provide them in your issue.

Suggesting enhancements

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps and goal of the enhancement in as many details as possible.
  • Explain why this enhancement is useful.

Your first code contribution

Unsure where to begin contributing to dt? You can start by looking through these beginner and help-wanted issues:

Good first issues - issues which should only require a few lines of code. Up for grab issues - issues which should be a bit more involved than beginner issues.

Pull requests

  • Fill in the required template.
  • Do not include issue numbers in the PR title.
  • Add tests if possible and senseful.
  • Ensure, that gofmt, govet and golint are satisfied. 😁
  • Ensure, that all changes fits the MIT license.