Skip to content

Commit

Permalink
Put workflows into contribution guide and clarified about development…
Browse files Browse the repository at this point in the history
… installation
  • Loading branch information
JezSw committed Mar 6, 2024
1 parent ccfefbb commit 407b101
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 6 deletions.
1 change: 0 additions & 1 deletion docs/source/dev/testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@ of the code which need to be performed each time the master code is adjourned.

Testing in JADE
---------------

Unit testing in JADE is defined and run with the help of the ``pytest`` module
while the code test coverage is monitored through the ``coverage`` one.

Expand Down
19 changes: 14 additions & 5 deletions docs/source/dev/workflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ An easy wasy to approach the world of git actions and their integration with Git

Branching model
---------------

.. figure:: /img/dev_guide/branching_model.svg
:width: 600
:align: center
Expand Down Expand Up @@ -97,15 +96,25 @@ following guidelines but the final decision beign discrentionary.

Contribution steps
------------------
These steps apply to both new features and bug fixes. The general steps for contributing
are as follows:
JADE follows the development process outlined in the diagram below, relying on
Github Issues to track requests and delivery of new features, benchmarks,
bugfixes and other developments.

.. figure:: /img/dev_guide/dev_process.svg
:width: 600
:align: center

Development process flow diagram for JADE showing the processes for
accepting issues, planning releases, reviewing Pull Requests and releasing.

The general steps for contributing are as follows:

#. Fork the main JADE repository from `GitHub <https://github.com/JADE-V-V/JADE>`_. This will create a
repository with the same name under your personal account. As such, you can commit
to it as you please without disrupting other developers.
#. Clone locally your fork of JADE and create a new branch off of the ``Developing`` one.
#. Setup your environment for developing JADE.
#. Install JADE (see :ref:`install`)
#. Install JADE for development (see :ref:`installdevelop`.)
#. Install the pre-commit hooks (``pre-commit install``) and check they
can run (``pre-commit run --all-files``).
#. Ensure you can run the tests (see :ref:`Testing In JADE <runtesting>`)
Expand All @@ -131,7 +140,7 @@ The following are minimum requirements necessary for the approval of a pull requ
`black formatter <https://github.com/psf/black>`_ should be run automatically
as part of the pre-commit hooks (see `Contribution steps`_).
* if a new feature is developed, new test cases must be added to unit test suites.
`pytest <https://docs.pytest.org/en/7.4.x/>`_ must be used. Some additional
`pytest <https://docs.pytest.org/en>`_ must be used. Some additional
info on this can be found at :ref:`testing`.
* no conflicts are allowed with the ``Developing`` branch, i.e., the original
``Developing`` branch should be pulled into the fork and all eventual
Expand Down
4 changes: 4 additions & 0 deletions docs/source/img/dev_guide/dev_process.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions docs/source/usage/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,18 @@ the installation:
| ``pip install --upgrade pip``
| ``pip install .``
.. _installdevelop:

Development Installation
^^^^^^^^^^^^^^^^^^^^^^^^

If you are developing JADE, you can use the '-e' option when installing and you should install the additional dev dependencies.

| ``pip install -e . ".[dev]"``
Running
^^^^^^^

JADE has now been installed as a command line tool and should now be initialised in the root directory as follows:

| ``cd ../``
Expand Down

0 comments on commit 407b101

Please sign in to comment.