doc: contributions

Author: azmeuk

README.md

@@ -10,7 +10,7 @@ pip install scim2-cli
 
 ## Usage
 
-Check the [tutorial](https://scim2-cli.readthedocs.io/en/latest/tutorial.html) and the [reference](https://scim2-cli.readthedocs.io/en/latest/reference.html) for more details.
+Check the [reference](https://scim2-cli.readthedocs.io/en/latest/reference.html) for more details.
 
 Here is an example of resource creation:
 

doc/conf.py

@@ -78,8 +78,3 @@
         "Miscellaneous",
     )
 ]
-
-# -- Options for autosectionlabel -----------------------------------------
-
-autosectionlabel_prefix_document = True
-autosectionlabel_maxdepth = 2

doc/contributing.rst

@@ -0,0 +1,47 @@
+Contributions
+=============
+
+Contributions are welcome!
+
+The repository is hosted at `github.com/yaal-coop/scim2-cli <https://github.com/yaal-coop/scim2-cli>`_.
+
+Discuss
+-------
+
+If you want to implement a feature or a bugfix, please start by discussing it with us on
+the `bugtracker <https://github.com/yaal-coop/scim2-cli/issues>`_.
+
+Unit tests
+----------
+
+To run the tests, you just can run `poetry run pytest` and/or `tox` to test all the supported python environments.
+Everything must be green before patches get merged.
+
+The test coverage is 100%, patches won't be accepted if not entirely covered. You can check the
+test coverage with ``poetry run pytest --cov --cov-report=html`` or ``tox -e coverage -- --cov-report=html``.
+You can check the HTML coverage report in the newly created `htmlcov` directory.
+
+Code style
+----------
+
+We use `ruff <https://docs.astral.sh/ruff/>`_ along with other tools to format our code.
+Please run ``tox -e style`` on your patches before submiting them.
+In order to perform a style check and correction at each commit you can use our
+`pre-commit <https://pre-commit.com/>`_ configuration with ``pre-commit install``.
+
+Documentation
+-------------
+
+The documentation is generated when the tests run:
+
+.. code-block:: bash
+
+    tox -e doc
+
+You can also run sphinx by hand, that should be faster since it avoids the tox environment initialization:
+
+.. code-block:: bash
+
+   sphinx-build doc build/sphinx/html
+
+The generated documentation is located at ``build/sphinx/html``.

doc/index.rst

@@ -1,15 +1,12 @@
 .. include:: ../README.md
    :parser: myst_parser.parsers.docutils_
 
-.. danger ::
-
-    scim2-cli is in very early development, there is not much to use yet!
-
 Table of contents
 -----------------
 
 .. toctree::
     :maxdepth: 2
 
     reference
+    contributing
     changelog