# Contributing Guidelines

We welcome contributions from the community to make COHESIVM better! If you'd like to contribute an implementation 
of a [``Device``](https://cohesivm.readthedocs.io/en/latest/reference/devices.html#cohesivm.devices.Device), 
an [``Interface``](https://cohesivm.readthedocs.io/en/latest/reference/interfaces.html#cohesivm.interfaces.Interface), 
a [``Measurement``](https://cohesivm.readthedocs.io/en/latest/reference/measurements.html#cohesivm.measurements.Measurement) 
or an [``Analysis``](https://cohesivm.readthedocs.io/en/latest/reference/analysis.html#cohesivm.analysis.Analysis), 
please follow these steps:

1. {octicon}`repo-forked;1em` [Fork the repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo#forking-a-repository) to your own GitHub account.
   
   


2. {octicon}`repo-clone;1em` [Clone your forked repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo#cloning-your-forked-repository) to your local machine.
   
   


3. {octicon}`git-branch;1em` Create a new branch for your new component: 
    ```console
    git checkout -b my-new-component
    ```
   
4. {octicon}`checklist;1em` Make your changes and ensure the code passes existing tests:
    ```console
    python -m pytest
    ```
   
5. {octicon}`codescan;1em` 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. {octicon}`git-commit;1em` Commit your changes with clear and concise messages.
   
   


7. {octicon}`repo-push;1em` Push your branch to your forked repository:
    ```console
    git push origin my-new-component
    ```
   
8. {octicon}`git-pull-request;1em` [Open a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) to the main repository, describing the changes and why they should be merged.
   
   


9. {octicon}`rocket;1em` 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](https://github.com/mxwalbert/cohesivm/issues).

Thank you for supporting us!