Updated contributing page to reflect changes of the last year.

master
Franco Masotti 8 months ago
parent 638f705423
commit 29cbb6cc04
Signed by: frnmst
GPG Key ID: 24116ED85666780A
  1. 2
      docs/conf.py
  2. 55
      docs/contributing_common.rst

@ -19,7 +19,7 @@ sys.path.insert(0, os.path.abspath('..'))
# -- Project information -----------------------------------------------------
project = 'fpydocs'
copyright = '2020-2021, Franco Masotti'
copyright = '2020-2022, Franco Masotti'
author = 'Franco Masotti'
# The short X.Y version.

@ -4,7 +4,7 @@ Contributing [common]
Git branches
------------
What follows is a table of the git branches used in these repositories.
What follows is a table of the git branches used in the repositories following fpydocs' specifications.
.. important:: Open pull requests on the ``dev`` target branch.
Use ``bugfix-${fix_name}`` or ``newfeature-${new_feature_name}`` as names.
@ -14,62 +14,53 @@ Branch Description
===================================== ==================================================== ==============================
``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
``bugfix-${fix_name}`` a generic bug fix -
``newfeature-${new_feature_name}`` a generic new feature -
===================================== ==================================================== ==============================
Dependencies
------------
Development environment
-----------------------
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:
1. install `Pipenv <https://pipenv.readthedocs.io/en/latest/>`_
2. run the following to install the development environment
::
::
make install-dev
$ make install-dev
3. you can use ``pipenv run`` to run the program in
the development environment
4. if you have changed parts of the source code you must take care of adding
the corresponding unit tests if applicable.
5. run the tests with:
This will also install the Python linters among other stuff.
Once you make changes you can install this project to have access to its executable file.
Install `pip <https://pypi.org/project/pip/>`_ and then:
::
::
make test
$ make install
6. to install the program for the running user run:
.. note:: don't forget to add ``~/.local/bin`` to ``PATH``.
::
Unit tests
----------
make install
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:
.. note:: don't forget to add ``~/.local/bin`` to ``PATH``.
::
$ make test
7. to rebuild the documentation run
Documentation
-------------
You can edit and rebuild all this documentation with:
::
::
$ make doc
make doc
TODO and FIXME

Loading…
Cancel
Save