Skip to content

Contributing guidelines

Welcome! SpeckCn2 is an open-source project for the analysis of speckle patterns. If you're trying SpeckCn2 with your data, your experience, questions, bugs you encountered, and suggestions for improvement are important to the success of the project.

We have a Code of Conduct, please follow it in all your interactions with the project.

Questions, feedback, bugs

Use the search function to see if someone else already ran across the same issue. Feel free to open a new issue here to ask a question, suggest improvements/new features, or report any bugs that you ran into.

Submitting changes

Even better than a good bug report is a fix for the bug or the implementation of a new feature. We welcome any contributions that help improve the code.

When contributing to this repository, please first discuss the change you wish to make via an issue with the owners of this repository before making a change.

Contributions can come in the form of:

  • Bug fixes
  • New features
  • Improvement of existing code
  • Updates to the documentation
  • ... ?

We use the usual GitHub pull request flow. For more info see GitHub's own documentation.

Typically this means:

  1. Forking the repository and/or make a new branch
  2. Making your changes
  3. Make sure that the tests pass and add your own
  4. Update the documentation is updated for new features
  5. Pushing the code back to Github
  6. Create a new Pull Request

One of the code owners will review your code and request changes if needed. Once your changes have been approved, your contributions will become part of SpeckCn2. 🎉

Getting started with development

Setup

SpeckCn2 targets Python 3.9 or newer.

Clone the repository into the speckcn2 directory:

git clone https://github.com/MALES-project/SpeckleCn2Profiler speckcn2
cd speckcn2

Initialize all submodules: 

git submodule update --recursive --init

Install using virtualenv:

python3 -m venv env
source env/bin/activate
python3 -m pip install -e .[develop]

Alternatively, install using Conda:

conda create -n speckcn2 python=3.10
conda activate speckcn2
pip install -e .[develop]

Running tests

SpeckCn2 uses pytest to run the tests. You can run the tests for yourself using:

pytest

Notice that some of the tests will fail the first time that you run them locally. After you get this failure message you can run

python ./scripts/setup_test.py

to stash the test data in the correct location. After that, you can run the tests again and they should pass.

To check coverage:

coverage run -m pytest
coverage report  # to output to terminal
coverage html    # to generate html report

Building the documentation

The documentation is written in markdown, and uses mkdocs to generate the pages.

To build the documentation for yourself:

pip install -e .[docs]
mkdocs serve

You can find the documentation source in the docs directory. If you are adding new pages, make sure to update the listing in the mkdocs.yml under the nav entry.

Making a release

  1. Make a new release.

  2. Under 'Choose a tag', set the tag to the new version. The versioning scheme we use is SemVer, so bump the version (major/minor/patch) as needed. Bumping the version is handled transparently by bumpversion in this workflow.

  3. The upload to pypi is triggered when a release is published and handled by this workflow.

  4. The upload to zenodo is triggered when a release is published.