diff --git a/docs/source/dev/testing.rst b/docs/source/dev/testing.rst index e0b1b273..8efdeb93 100644 --- a/docs/source/dev/testing.rst +++ b/docs/source/dev/testing.rst @@ -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. diff --git a/docs/source/dev/workflow.rst b/docs/source/dev/workflow.rst index 5b0089bd..eec48ca0 100644 --- a/docs/source/dev/workflow.rst +++ b/docs/source/dev/workflow.rst @@ -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 @@ -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 `_. 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 `) @@ -131,7 +140,7 @@ The following are minimum requirements necessary for the approval of a pull requ `black formatter `_ 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 `_ must be used. Some additional + `pytest `_ 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 diff --git a/docs/source/img/dev_guide/dev_process.svg b/docs/source/img/dev_guide/dev_process.svg new file mode 100644 index 00000000..722ccc62 --- /dev/null +++ b/docs/source/img/dev_guide/dev_process.svg @@ -0,0 +1,4 @@ + + + +
Accepted
Accepted
Refused
Refused
Issue Prioritisation
Issue Prioriti...
Selected Issues
for Release
Selected Issues...
Release
Planning
Release...
Issues
Issues
Development
Development
Work Planning
Work Planni...
Review and Approval
Review and Ap...
Release
Release
Issues not selected
for Release
(Backlog)
Issues not selected...
Accepted
Accepted
Rejected
Rejected
Release
Process
Release...
Release X.Y.Z
Release X.Y.Z
Issues
Issues
Issues
Issues
Issues
Issues
Create branch for feature
Create branch for...
Issues
Issues
Issues
Issues
Issues
Issues
Create Pull Request (PR)
Create Pull Reque...
Issues
Issues
Issues
Issues
Issues
Issues
Create issues for new features
Create issues for...
Write
Code
Write...Text is not SVG - cannot display \ No newline at end of file diff --git a/docs/source/usage/installation.rst b/docs/source/usage/installation.rst index 7bece217..1d33882c 100644 --- a/docs/source/usage/installation.rst +++ b/docs/source/usage/installation.rst @@ -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 ../``