Merge pull request #12 from chclaus/chclaus-contributing-guideline

Create CONTRIBUTING.md

CONTRIBUTING.md

@@ -0,0 +1,49 @@
+# Contributing to dt
+
+At first: Thank you for contributing to dt! :tada: :octocat:
+
+#### Table Of Contents
+
+[Code of Conduct](#code-of-conduct)
+[How can I contribute?](#how-can-i-contribute)
+  * [Reporting bugs](#reporting-bugs)
+  * [Suggesting enhancements](#suggesting-enhancements)
+  * [Your first code contribution](#your-first-code-contribution)
+  * [Pull requests](#pull-requests)
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by the [Developer-Toolbelt Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [ch.claus@me.com](mailto: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](https://github.com/chclaus/dt/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) - issues which should only require a few lines of code.
+[Up for grab issues](https://github.com/chclaus/dt/issues?q=is%3Aissue+is%3Aopen+label%3A%22Up+For+Grabs%22) - issues which should be a bit more involved than beginner issues.
+
+### Pull requests
+
+- Fill in the [required template](https://github.com/chclaus/dt/PULL_REQUEST_TEMPLATE.md).
+- Do not include issue numbers in the PR title.
+- Add tests if possible and senseful.
+- Ensure, that gofmt, govet and golint are satisfied. :grin:
+- Ensure, that all changes fits the MIT license.