diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2021-10-27 03:02:19 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2021-10-27 03:02:19 +0000 |
commit | f2038241cc91dbeee206151c1c17a3c42c5e1968 (patch) | |
tree | 33c29ba68db5ed7e9455a3922ff5f130ba52996e /docs/contribute.rst | |
parent | Initial commit. (diff) | |
download | pydyf-f2038241cc91dbeee206151c1c17a3c42c5e1968.tar.xz pydyf-f2038241cc91dbeee206151c1c17a3c42c5e1968.zip |
Adding upstream version 0.1.1.upstream/0.1.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'docs/contribute.rst')
-rw-r--r-- | docs/contribute.rst | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/docs/contribute.rst b/docs/contribute.rst new file mode 100644 index 0000000..adf9024 --- /dev/null +++ b/docs/contribute.rst @@ -0,0 +1,70 @@ +Contribute +========== + +You want to add some code to pydyf, launch its tests or improve its +documentation? Thank you very much! Here are some tips to help you play with +pydyf in good conditions. + +The first step is to clone the repository, create a virtual environment and +install pydyf dependencies. + +.. code-block:: shell + + git clone https://github.com/CourtBouillon/pydyf.git + cd pydyf + python -m venv venv + venv/bin/pip install .[doc,test] + +You can then let your terminal in the current directory and launch Python to +test your changes. ``import pydyf`` will then import the working directory +code, so that you can modify it and test your changes. + +.. code-block:: shell + + venv/bin/python + + +Code & Issues +------------- + +If you’ve found a bug in pydyf, it’s time to report it, and to fix it if you +can! + +You can report bugs and feature requests on GitHub_. If you want to add or +fix some code, please fork the repository and create a pull request, we’ll be +happy to review your work. + +.. _GitHub: https://github.com/CourtBouillon/pydyf + + +Tests +----- + +Tests are stored in the ``tests`` folder at the top of the repository. They use +the pytest_ library. + +Launching tests require to have Ghostscript_ installed and available in +``PATH``. + +You can launch tests (with code coverage and lint) using the following command:: + + venv/bin/pytest + +.. _pytest: https://docs.pytest.org/ +.. _Ghostscript: https://www.ghostscript.com/ + + +Documentation +------------- + +Documentation is stored in the ``docs`` folder at the top of the repository. It +relies on the Sphinx_ library. + +You can build the documentation using the following command:: + + venv/bin/sphinx-build docs docs/_build + +The documentation home page can now be found in the ``docs/_build/index.html`` +file. You can open this file in a browser to see the final rendering. + +.. _Sphinx: https://www.sphinx-doc.org/ |