Contributing

Report issues

Reporting issues is the first way to contribute to the software.

You can report global issue with the software on the issues tracker of QOSST at https://github.com/qosst/qosst/issues.

It is however preferable to use the specialized repo for issues that are specific to a module:

Module	URL of the issues tracker
qosst-core	https://github.com/qosst/qosst-core/issues
qosst-hal	https://github.com/qosst/qosst-hal/issues
qosst-alice	https://github.com/qosst/qosst-alice/issues
qosst-bob	https://github.com/qosst/qosst-bob/issues
qosst-skr	https://github.com/qosst/qosst-skr/issues
qosst-sim	https://github.com/qosst/qosst-sim/issues

Please include the following information when reporting a bug

• description of the bug;

• versions of the QOSST software;

• configuration file;

• used hardware, if relevant;

• logs of the error.

When requesting new feature, please provide a detailed description of what you propose and any reference that could be relevant.

Proposing code

You can propose code, either to solve issues or to propose new features directly.

If you want to solve an issue please comment on the issue on the issue tracker so we can assign the assign to you.

Here are the steps you should do:

1. Fork the repository on your github account;

2. Clone your forked repository;

3. Make the changes and commit;

4. Push to your forked repository;

5. Open a Pull Request on the associated repository.

We will then check the changes and merge when it’s ready.