updating contributing

CONTRIBUTING.md

@@ -0,0 +1,84 @@
+# 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 [`Issues`](https://github.com/Hethsron/lbph/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.
+
+### Submit Feedback
+
+The best way to send feedback is to file an issue at [`Issues`](https://github.com/Hethsron/lbph/issues).
+
+If you are proposing a 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 `lbph` for local development.
+
+1. Fork the `lbph` repo on GitHub.
+2. Clone your fork locally::
+
+    ```console
+        $ git clone [email protected]:your_name_here/lbph.git
+    ```
+
+3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
+
+    ```console
+        $ mkvirtualenv lbph
+        $ cd lbph/
+        $ python setup.py develop
+    ```
+
+4. Create a branch for local development::
+
+    ```console
+        $ git checkout -b name-of-your-bugfix-or-feature
+    ```
+
+   Now you can make your changes locally.
+
+5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
+
+    ```console
+        $ flake8 lbph tests
+        $ python setup.py test or py.test
+        $ tox
+    ```
+
+   To get flake8 and tox, just pip install them into your virtualenv.
+
+6. Commit your changes and push your branch to GitHub::
+
+    ```console
+        $ git add .
+        $ git commit -m "Your detailed description of your changes."
+        $ git push origin name-of-your-bugfix-or-feature
+    ```
+
+7. 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.md`](README.md).