Contributing
=============

We welcome community contributions! Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated** 👐.

If you have a suggestion that would make this better, please fork the repo and create a pull request for your changes as described step by step below. You can also simply open a feature request `issue <https://github.com/Infineon/arduino-core-psoc6/issues>`_.

1. `Fork <https://github.com/Infineon/arduino-core-psoc6/fork>`_ this repository
2. Create your feature branch (``git checkout -b feature/amazing-feature``)
3. Commit your changes (``git commit -sm 'folder/sub-folder: Add some amazing-feature.'``)
4. Push to the branch (``git push origin feature/amazing-feature``)
5. Open a `pull request <https://github.com/Infineon/arduino-core-psoc6/pulls>`_

Before submitting a pull request, please check the `code of conduct <https://github.com/Infineon/arduino-core-psoc6/blob/main/CODE_OF_CONDUCT.md>`_ and `code conventions <https://github.com/Infineon/arduino-core-psoc6/blob/main/CODE_CONVENTIONS.md>`_ for the PSOC™ 6 for Arduino project. 

.. important::
    Significant contributions should be aligned with the project team in advance. Please open an issue to discuss your ideas before starting work on a large feature or change.
    This helps ensure that your contributions align with the project's goals and standards.

Additionally, the following sections might be helpful for developing and testing your contributions:

    - :doc:`env-setup`
    - :doc:`run-tests`
    - :doc:`metafiles-naming`

Thank you for following these guidelines!