convrted contributing.rst to markdown (#33)

CONTRIBUTING.md

@@ -0,0 +1,147 @@
+# Contributing
+
+Contributions are welcome, and they are greatly appreciated! Every
+little bit helps, and credit will always be given.
+
+You can contribute in many ways:
+
+# Types of Contributions
+
+## Report Bugs
+
+Report bugs at <https://github.com/fpgmaas/cookiecutter-poetry/issues
+
+If you are reporting a bug, please include:
+
+-   Your operating system name and version.
+-   Any details about your local setup that might be helpful in
+    troubleshooting.
+-   Detailed steps to reproduce the bug.
+
+## Fix Bugs
+
+Look through the GitHub issues for bugs. Anything tagged with "bug"
+and "help wanted" is open to whoever wants to implement a fix for it.
+
+## Implement Features
+
+Look through the GitHub issues for features. Anything tagged with
+"enhancement" and "help wanted" is open to whoever wants to
+implement it.
+
+## Write Documentation
+
+Cookiecutter PyPackage could always use more documentation, whether as
+part of the official docs, in docstrings, or even on the web in blog
+posts, articles, and such.
+
+## Submit Feedback
+
+The best way to send feedback is to file an issue at
+<https://github.com/fpgmaas/cookiecutter-poetry/issues.
+
+If you are proposing a new feature:
+
+-   Explain in detail how it would work.
+-   Keep the scope as narrow as possible, to make it easier to
+    implement.
+-   Remember that this is a volunteer-driven project, and that
+    contributions are welcome :)
+
+# Get Started!
+
+Ready to contribute? Here\'s how to set up
+`cookiecutter-poetry` for local development. Please note
+this documentation assumes you already have `poetry` and
+`git` installed and ready to go.
+
+1. Fork the `cookiecutter-poetry` repo on GitHub.
+
+2. Clone your fork locally:
+
+  ``` bash
+  cd <directory_in_which_repo_should_be_created
+  git clone git@github.com:YOUR_NAME/cookiecutter-poetry.git
+  ```
+
+3. Now we need to install the environment. Navigate into the project directory:
+
+``` bash
+cd cookiecutter-poetry
+```
+
+If you are using `pyenv`, select a version to use locally. (See
+installed versions with `pyenv versions`)
+
+``` bash
+pyenv local <x.y.z
+```
+
+Then, install and activate the environment with:
+
+``` bash
+poetry install
+poetry shell
+```
+
+4. Create a branch for local development:
+
+``` bash
+git checkout -b name-of-your-bugfix-or-feature
+```
+
+Now you can make your changes locally.
+
+5. Don\'t forget to add test cases for your added functionality to the
+  `tests` directory.
+
+6. When you\'re done making changes, check that your changes pass the
+  formatting tests.
+
+``` bash
+make lint
+```
+
+7. Now, validate that all unit tests are passing:
+
+``` bash
+make test
+```
+
+8. Before raising a pull request you should also run tox. This will
+  run the tests across different versions of Python:
+
+``` bash
+tox
+```
+
+This requires you to have multiple versions of Python installed. This
+step is also triggered in the CI/CD pipeline, so you could also choose
+to skip this step locally.
+
+9. Reflect your changes in the documentation. Update relevant files in
+  the `docs` directory, and potentially the `README`. You can check the
+  updated documentation with
+
+``` bash
+make docs
+```
+
+10. Commit your changes and push your branch to GitHub:
+
+``` bash
+git add .
+git commit -m "Your detailed description of your changes."
+git push origin name-of-your-bugfix-or-feature
+```
+
+11. Submit a pull request through the GitHub website.
+
+# Pull Request Guidelines
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1.  The pull request should include tests.
+2.  If the pull request adds functionality, the docs should be updated.
+    Put your new functionality into a function with a docstring, and add
+    the feature to the list in README.rst.