Skip to content

Contributing to quiCAT

Contributions are welcome, and they are greatly appreciated!

Types of Contributions

Report Bugs

Report bugs at GitHub Issues

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Please use the bug_report issue template.

Feature request

he best way to send feedback is to file an issue at GitHub Issues.

If you are proposing a new feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.

Use the feature_request issue template.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" is open to whoever wants to implement a fix for it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" is open to whoever wants to implement it.

Write Documentation

quiCAT could always use more documentation, improvements on the existing one, tutorials etc.

Get Started

Ready to contribute? Here's how to set up quiCAT for local development. Please note this documentation assumes you already have poetry and Git installed and ready to go.

  1. Fork the quiCAT repo on GitHub.

  2. Clone your fork locally:

cd <directory_in_which_repo_should_be_created>
git clone git@github.com:YOUR_NAME/quicat.git
  1. Now we need to install the environment. Navigate into the directory
cd quicat

If you are using pyenv, select a version to use locally. (See installed versions with pyenv versions)

pyenv local <x.y.z>

Then, install and activate the environment with:

make install
  1. Create a branch for local development:
git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

  1. Don't forget to add test cases for your added functionality to the tests directory.

  2. When you're done making changes, check that your changes pass the formatting tests.

make check
  1. Now, validate that all unit tests are passing:
make test
  1. Commit your changes and push your branch to GitHub:
git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature
  1. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request must include tests.

  2. If the pull request adds functionality, the docs should be updated.

Note

quiCAT implements pre-commit checks with ruff and mypy

PRs not passing these checks will not be merged.