Contributing Guidelines

We welcome contributions from the community to make COHESIVM better! If you’d like to contribute an implementation of a Device, an Interface, a Measurement or an Analysis, please follow these steps:

1. Fork the repository to your own GitHub account.

2. Clone your forked repository to your local machine.

3. Create a new branch for your new component:

   git checkout -b my-new-component
   

4. Make your changes and ensure the code passes existing tests:

   python -m pytest
   

5. Add new tests for your changes, if applicable.

   Note

   This may require a new custom marker in the conftest.py. For example, if you implement new hardware which should only be tested if it is physically connected.

6. Commit your changes with clear and concise messages.

7. Push your branch to your forked repository:

   git push origin my-new-component
   

8. Open a pull request to the main repository, describing the changes and why they should be merged.

9. You successfully contributed to COHESIVM!

Important

Please make sure to follow the project’s structure. The best way to start is to have a look at the tutorials in the documentation.

You may also contribute by submitting feature requests, bugs and other issues over GitHub.

Thank you for supporting us!