Fixed documentation.

This commit is contained in:
Franco Masotti 2020-10-18 12:43:52 +02:00
parent 6a06bc229a
commit 9a72e9ccfe
Signed by: frnmst
GPG Key ID: 24116ED85666780A
3 changed files with 7 additions and 101 deletions

View File

@ -1,6 +1,8 @@
Contributing
============
`Contributing [common] <https://frnmst.github.io/fpydocs/>`_ version `0.0.1 <https://github.com/frnmst/fpydocs/releases/tag/0.0.1>`_
Talk
----
@ -8,113 +10,12 @@ Suggestions, improvements and discussion:
- https://gitter.im/fattura-elettronica-reader/community
Git branches
------------
What follows is a table of the git branches used in this repository.
.. important:: Open pull requests on the ``dev`` target branch.
Use ``bugfix-${fix_name}`` or ``newfeature-${new_feature_name}`` as names.
===================================== ==================================================== ==============================
Branch Description Update schedule
===================================== ==================================================== ==============================
``master`` the main branch every new release
``dev`` recent changes are merged here before a new release at will
``gh-pages`` contains the built documentation only every new release
``bugfix-${fix_name}`` a generic bug fix
``newfeature-${new_feature_name}`` a generic new feature
===================================== ==================================================== ==============================
Dependencies
------------
First of all install `pipenv <https://pipenv.readthedocs.io/en/latest/>`_ and then
install the software requirements from the Pipfile in the repository's root:
::
$ make install-dev
.. note:: don't forget to add ``~/.local/bin`` to ``PATH``.
Unit tests
----------
If you have changed parts of the source code you MUST take care of adding
the corresponding unit tests. Once you have done that run the following command
in a terminal:
::
$ make test
You can also add this command before every git commit as by running:
::
$ make githook
Python PEP compliancy
---------------------
To be able to lint and test for PEP compliancy you need to run:
::
$ make pep
Documentation
-------------
You can edit and rebuild all this documentation with:
::
$ make doc
TODO and FIXME
--------------
Go in the repository's root and then:
::
grep -e TODO -e FIXME -n */*.py
Important stuff
```````````````
- unit tests: I guess we should use the examples from the government's website,
if the license permits it.
- GUI: for example https://github.com/chriskiehl/Gooey
- i18n (both CLI and GUI): https://docs.python.org/3/library/gettext.html
Contribution Steps
------------------
1. clone the repository
2. install the requirements
3. write code
4. write unit tests
5. run tests
6. run PEP linter and check
7. update relevant documentation, if necessary
8. pull request
.. note:: Have a look at `this post <https://frnmst.gitlab.io/notes/my-python-release-workflow.html>`_ as well.

View File

@ -15,6 +15,7 @@ Welcome to fattura-pa-reader's documentation!
considerations
examples
contributing
workflow
source_code
copyright_license

4
docs/workflow.rst Normal file
View File

@ -0,0 +1,4 @@
Workflow
========
`Workflow [common] <https://frnmst.github.io/fpydocs/workflow_common.html>`_ version `0.0.1 <https://github.com/frnmst/fpydocs/releases/tag/0.0.1>`_