diff options
Diffstat (limited to 'docs/developers.rst')
| -rw-r--r-- | docs/developers.rst | 51 |
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 |
