Skip to content

Latest commit

 

History

History
77 lines (44 loc) · 2.61 KB

CONTRIBUTING.md

File metadata and controls

77 lines (44 loc) · 2.61 KB
Raw

Contributing

Bug report and feature suggestion

If you have found an issue with qlasskit, first do a search in the Qlasskit issue tracker to ensure that there are no existing issues with similar content. If you can't find another related issue, open a new one: please try to be as detailed as possible.

Submit a pull request

If you want to contribute to qlasskit, you have to follow this flow:

  1. First fork the qlasskit repository so you can work on your copy of the code
  2. Clone it locally by running git clone https://github.com/YOUR_USERNAME/qlasskit.git
  3. Add the original repo as upstream git remote add upstream https://github.com/dakk/qlasskit.git

We also suggest to use pyenv to create an isolated pip environment:

  • Create a new env: pyenv virtualenv qlasskit-env
  • Activate it: pyenv activate qlasskit-env

Working on the code

  1. Now that you have your local copy of qlasskit, you can start working on the code; first, search or create the issue you want to contribute to in the qlasskit issue tracker, and ask to be assigned to that issue in order to avoid duplicate work.

  2. Create e new branch with a descriptibe name where you will do the changes; the starting point is always upstream/main:

git fetch upstream
git checkout -b your-branch-name upstream/master
  1. Before each commit, use tox (pip install tox) in order to check that typechecker, linters and tests run fine:

tox

Use short and descriptive commit message, and remember to add tests to check new functionalities.

  1. If your branch drifts out of sync from upstream/main, you can fetch and merge the updated version:

git pull upstream main

  1. Finally push your code in your branch

git push origin your-branch-name

  1. Once you're happy with your changes, visit qlasskit github and start a new pull request from USERNAME:your-branch-name to dakk:main. Maintainers will start reviewing your code and they may ask you to do some changes (in your branch): PR updates automatically every time you push to your working branch.

Make docs

You can also create docs locally in order to check if everything is as expected:

pip install sphinx sphinx_rtd_theme sphinx_rtd_dark_mode myst_nb
cd docs
make html

Publish a new release (maintainers only)

  1. Update qlasskit version in qlasskit/__init__.py

  2. Create a new tag and a new release on github

  3. Submit the release on pypi using twine:

rm -r dist/*
python -m build
python -m twine upload dist/*