Skip to content

Latest commit

 

History

History
50 lines (43 loc) · 1.1 KB

CONTRIBUTING.md

File metadata and controls

50 lines (43 loc) · 1.1 KB

Developer Contribution Guide

Contribute to the repository by opening a pull request.

Local

Clone the source code.

git clone git@github.com:TomographicImaging/CILViewer.git

Navigate the folder.

cd CILViewer

Create a new environment.

conda env create –f Wrappers/Python/conda-recipe/environment.yml

Activate the environment.

conda activate cilviewer

Install the package.

pip install ./Wrappers/Python --no-dependencies

Run tests

Before merging a pull request, all tests must pass. Install the required packages:

conda install eqt pillow pyside2 pytest -c ccpi cil-data=22.0.0

Tests can be run locally from the repository folder

python -m pytest Wrappers/Python/test

Continuous integration

Changelog

Located in CHANGELOG.md.

Changelog style

The changelog file needs to be updated manually every time a pull request (PR) is submitted.

  • Itemise the message with "-".
  • Be concise by explaining the overall changes in only a few words.
  • Mention the relevant PR.
Example:
  • Add CONTRIBUTING.md #403