.. _sec-contribute:
Contributing
============

We welcome contributions to the `pyrootmemo` project! Whether you want to report a bug, suggest an improvement, or contribute code, your input is valuable. Here are some guidelines to help you get started:

1. **Reporting Issues**: If you find a bug or have a feature request, please open an issue on the `Github repository`_. Provide as much detail as possible, including steps to reproduce the issue, expected behavior, and any relevant code snippets.

2. **Suggesting Improvements**: If you have ideas for improving the documentation or the codebase, feel free to open an issue or submit a pull request. We appreciate any suggestions that can enhance the usability and functionality of `pyrootmemo`. 

3. **Contributing Code**: If you want to contribute code, please follow these steps:
   - Fork the repository and clone it to your local machine.
   - Create a new branch for your changes.
   - Make your changes and ensure that they are well-documented and tested.
   - Submit a pull request with a clear description of the changes you made and why they are necessary.

4. **Documentation**: If you want to contribute to the documentation, please follow the existing structure and style. You can use reStructuredText (reST) format for documentation files. If you're not familiar with reST, you can find more information in the `Sphinx documentation`_.

5. **Code Style**: Please adhere to the coding style used in the project. We follow PEP 8 guidelines for Python code.

6. **Testing**: Ensure that your changes do not break existing functionality. Run the test suite and add new tests if necessary. You can find the tests in the `tests` directory.

7. **License**: By contributing to `pyrootmemo`, you agree that your contributions will be licensed under the same license as the project (MIT License).

8. **Communication**: If you have any questions or need help, feel free to reach out to us via e-mail .

We appreciate your interest in contributing to `pyrootmemo` and look forward to your contributions!


.. _Github repository: https://github.com/rootmemo/pyrootmemo/issues/new
.. _Sphinx documentation: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html