add contributing section to documentation

Author: MarwanDebbiche

CONTRIBUTING.md

@@ -0,0 +1,50 @@
+# How to contribute to pylambdarest
+
+Thank you for considering contributing to pylambdarest!
+
+## First time setup
+
+- Make sure you have a [GitHub account](https://github.com/join).
+
+- Fork pylambdarest to your GitHub account by clicking the [Fork](https://github.com/MarwanDebbiche/pylambdarest/fork) button.
+
+- Install [poetry](https://python-poetry.org/).
+
+- Install dependecies using poetry:
+
+```shell
+poetry install
+```
+
+- Install the pre-commit hooks:
+
+```shell
+poetry run pre-commit install --install-hooks
+```
+
+- Run the tests to make sure you are all set:
+
+```shell
+poetry run coverage run -m --source=pylambdarest pytest tests && poetry run coverage report -m
+```
+
+## Building the docs
+
+Build the docs in the docs directory using Sphinx:
+
+```shell
+cd docs
+poetry run make html
+```
+
+Open `build/html/index.html` in your browser to view the docs.
+
+Read more about [Sphinx](https://www.sphinx-doc.org/en/master/).
+
+## Submitting patches
+
+Include the following in your patch:
+
+- Use Black to format your code. This and other tools will run automatically if you install pre-commit using the instructions above.
+- Include tests if your patch adds or changes code. Make sure the test fails without your patch.
+- Update the documentation accordingly if needed.

docs/source/conf.py

@@ -13,7 +13,6 @@
 import os
 import sys
 
-
 PROJECT_ROOT_DIR = os.path.dirname(os.path.dirname((os.path.abspath("."))))
 sys.path.insert(0, PROJECT_ROOT_DIR)
 
@@ -31,7 +30,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    "m2r2",
+    "m2r",
     "sphinx.ext.autodoc",
     "sphinx.ext.napoleon",
     "sphinx_rtd_theme",

docs/source/contributing.rst

@@ -0,0 +1 @@
+.. mdinclude:: ../../CONTRIBUTING.md

docs/source/index.rst

@@ -3,6 +3,8 @@
    :hidden:
 
    api_reference
+   contributing
+
 
 .. mdinclude:: ../../README.md