From 8bf7ff8691f64c95a8afdda77b9cd4aee95b2ee6 Mon Sep 17 00:00:00 2001 From: Moul <moul@moul.re> Date: Sat, 8 May 2021 20:03:06 +0200 Subject: [PATCH] =?UTF-8?q?[doc]=20contributing:=20Add=20=C2=A7=20to=20sug?= =?UTF-8?q?gest=20to=20read=20used=20modules=20docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index abc536c5..d8ddeec5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -35,6 +35,15 @@ Use DuniterPy as a [path dependency](https://python-poetry.org/docs/versions/#pa poetry add ../duniterpy ``` +### Developing with modules +Silkaj is using Python modules which shape kind of a framework. +Please read their documentations on how to use them the best possible. +- [DuniterPy](https://clients.duniter.io/python/duniterpy/index.html): Autogenerated documentation. + - Feel free to contribute upstream to share the code with other Python programs +- [Click](https://click.palletsprojects.com/#documentation) +- [Pendulum](https://pendulum.eustace.io/docs/) +- [texttable](https://github.com/foutaise/texttable/#documentation) + ## Formatting We are using [Black](https://github.com/python/black) formatter tool. To have Black installed in your Poetry virtualenv, you will need Python v3.6 or greater. @@ -112,7 +121,7 @@ The `--extra-index-url` is used to retrieve dependencies packages from the offic - Build - Tests on supported Python versions: - Installation - - Pytest for v3.6, 3.7, and 3.8 + - Pytest on Python supported versions - PyPI distribution - test - stable -- GitLab