Skip to content

Contributing to the development of qkit

S1 edited this page Nov 9, 2021 · 1 revision

How to contribute

  • Create a GitHub account
  • Go on any page of the qkit repository and klick on Fork on the top right corner
  • You now have your own copy of qkit, on which you have every right to edit and upload new files.
  • When you are done (see notes below), klick on Pull requests => New pull request => Create pull requests
  • The qkit developer team gets notified, will respond to your changes, and eventually include them in the official qkit repository.

Notes on contributing

  • If you add new files (scrips or drivers), add a sample notebook to demonstrate its use under qkit/doc/notebooks
  • Please test the code thoroughly before you create the pull request
  • It is generally better to include already early versions of a driver (and note the ToDos in the code) than waiting for the final version.
Clone this wiki locally