Contributing to HSR
======================

We’re thrilled that you’re interested in contributing to HSR! Your
contributions are essential for keeping HSR robust and valuable for
everyone. Whether you’re reporting issues, suggesting improvements, or
submitting code changes, every contribution is appreciated.

Reporting Issues and Suggesting Improvements
--------------------------------------------

If you encounter bugs, errors, or areas of improvement in HSR, we
encourage you to open an issue in our `repository <https://github.com/marcellocostamagna/HSR>`_. When creating an
issue, please provide:

-  A clear and descriptive title.
-  A detailed description of the problem or suggestion.
-  Steps to reproduce the issue (if applicable).
-  Any additional context or screenshots that might be helpful.

Your reports are invaluable in identifying and fixing problems and in
making HSR more efficient.

Contributing Code or Documentation
----------------------------------

If you’re looking to contribute code or documentation to HSR, the
typical process involves:

1. **Forking the Repository**: Start by forking the HSR repository to
   your GitHub account. This creates your own copy of the project where
   you can make your changes.

2. **Making Your Changes**: Once you’ve forked the repo, you can start
   making your changes. Whether it’s fixing a bug, adding a feature, or
   improving documentation, your contributions are welcome.

3. **Testing Your Changes**: Before submitting your changes, please test
   them to ensure they work as expected and don’t introduce any new
   issues.

4. **Creating a Pull Request**: After you’ve made your changes, create a
   pull request from your forked repository to the main HSR
   repository. In your pull request, provide a clear description of the
   changes and any other relevant information.

5. **Review Process**: Once your pull request is submitted, it will be
   reviewed by the maintainers of HSR. There might be a discussion
   about the changes. Be open to feedback and willing to make
   adjustments if needed.

6. **Merging**: After your pull request is approved, a maintainer will
   merge it into the main repository. Congratulations, and thank you for
   your contribution!

Guidelines for Contributions
----------------------------

-  Ensure your code adheres to the existing style for consistency.
-  Keep your changes focused and limited to a single issue or feature to
   make the review process quicker and more efficient.
-  Update or add tests as necessary to cover your changes.
-  Update the documentation to reflect your changes if applicable.

Questions or Need Help?
-----------------------

If you have questions or need help with the contribution process, feel
free to reach out to the maintainers or open an issue for discussion.
(TODO: add contacts information)
Thank you for contributing to HSR, and we look forward to your
contributions! 
