Skip to content

Latest commit

 

History

History
90 lines (61 loc) · 3.05 KB

CONTRIBUTING.md

File metadata and controls

90 lines (61 loc) · 3.05 KB
Raw

How to contribute

We're grateful for your interest in participating in Qadence. Please follow our guidelines to ensure a smooth contribution process.

Reporting an issue or proposing a feature

Your course of action will depend on your objective, but generally, you should start by creating an issue. If you've discovered a bug or have a feature you'd like to see added to qadence, feel free to create an issue on qadence's GitHub issue tracker. Here are some steps to take:

  1. Quickly search the existing issues using relevant keywords to ensure your issue hasn't been addressed already.
  2. If your issue is not listed, create a new one. Try to be as detailed and clear as possible in your description.
  • If you're merely suggesting an improvement or reporting a bug, that's already excellent! We thank you for it. Your issue will be listed and, hopefully, addressed at some point.
  • However, if you're willing to be the one solving the issue, that would be even better! In such instances, you would proceed by preparing a Pull Request.

Submitting a pull request

We're excited that you're eager to contribute to Qadence. To contribute, fork the main branch of qadence repository and once you are satisfied with your feature and all the tests pass create a Pull Request.

Here's the process for making a contribution:

Click the "Fork" button at the upper right corner of the repo page to create a new GitHub repo at https://github.com/USERNAME/qadence, where USERNAME is your GitHub ID. Then, cd into the directory where you want to place your new fork and clone it:

git clone https://github.com/USERNAME/qadence.git

Next, navigate to your new qadence fork directory and mark the main qadence repository as the upstream:

git remote add upstream https://github.com/pasqal-io/qadence.git

Setting up your development environment

We recommended to use hatch for managing environments:

To develop within qadence, use:

pip install hatch
hatch -v shell

To run qadence tests, use:

hatch -e tests run test

If you don't want to use hatch, you can use the environment manager of your choice (e.g. Conda) and execute the following:

pip install pytest
pip install -e .
pytest

Useful things for your workflow: linting and testing

Use pre-commit to lint your code and run the unit tests before pushing a new commit.

Using hatch, it's simply:

hatch -e tests run pre-commit run --all-files
hatch -e tests run test

Our CI/CD pipeline will also test if the documentation can be built correctly. To test it locally, please run:

hatch -e docs run mkdocs build --clean --strict

Without hatch, pip install those libraries first: "mkdocs", "mkdocs-material", "mkdocstrings", "mkdocstrings-python", "mkdocs-section-index", "mkdocs-jupyter", "mkdocs-exclude", "markdown-exec"

And then:

 mkdocs build --clean --strict