Add basic contributing page

parttimenerd · Jul 11, 2019 · 8259a1b · 8259a1b
1 parent ca06fd2
commit 8259a1b
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 3 deletions.
diff --git a/doc/contributing.rst b/doc/contributing.rst
@@ -0,0 +1,18 @@
+Contributing
+============
+
+Pull requests and issues are always welcomed.
+
+Testing
+-------
+
+The tests are located in the ``tests`` folder and roughly grouped by the temci subcommand they belong to.
+New features should by covered by tests.
+
+The tests are using the pytest framework and can be executed by simply calling
+
+.. code:: sh
+
+    pytest
+
+It recommended to install the package ``pytest-clarity`` to improve the error output.
diff --git a/doc/development.rst b/doc/development.rst
diff --git a/doc/index.rst b/doc/index.rst
@@ -18,7 +18,7 @@ Contents of this documentation
    os_support
    resources
    changelog
-   development
+   contributing
    license
    temci