aboutsummaryrefslogtreecommitdiff
path: root/docs/developers.rst
diff options
context:
space:
mode:
authorCharles Cabergs <me@cacharle.xyz>2021-02-26 14:49:49 +0100
committerCharles Cabergs <me@cacharle.xyz>2021-02-26 14:52:48 +0100
commitc2ca0d297b8e067c5e315500fb2f35f50ff6af8a (patch)
tree18c16c0f0ffdb08698c1ba76efc7dc78909beea8 /docs/developers.rst
parentad7233a4a5f45be6f991ed38a7351a6ef826356b (diff)
downloadminishell_test-c2ca0d297b8e067c5e315500fb2f35f50ff6af8a.tar.gz
minishell_test-c2ca0d297b8e067c5e315500fb2f35f50ff6af8a.tar.bz2
minishell_test-c2ca0d297b8e067c5e315500fb2f35f50ff6af8a.zip
Added docs draft
Diffstat (limited to 'docs/developers.rst')
-rw-r--r--docs/developers.rst51
1 files changed, 51 insertions, 0 deletions
diff --git a/docs/developers.rst b/docs/developers.rst
new file mode 100644
index 0000000..17307cd
--- /dev/null
+++ b/docs/developers.rst
@@ -0,0 +1,51 @@
+Developers
+==========
+
+Install requirements
+--------------------
+
+.. include:: ../requirements-dev.txt
+ :literal:
+
+.. code-block::
+
+ $ pip3 instal -r requirements-dev.txt
+
+Install in *editable* mode
+--------------------------
+
+.. code-block::
+
+ $ git clone https://github.com/cacharle/minishell_test
+ $ cd minishell_test
+ $ pip3 install -e .
+
+This make it possible to modify the source and see the changes live.
+
+Linting
+-------
+
+.. code-block::
+
+ $ flake8 minishell_test
+
+Type checking
+-------------
+
+.. code-block::
+
+ $ mypy minishell_test
+
+Unit Test
+---------
+
+.. code-block::
+
+ $ pytest
+
+Cross environment testing
+-------------------------
+
+.. code-block::
+
+ $ tox