Contributing Guide
==================

Thank you for considering contributing to this project! Your support is invaluable.

How to Contribute
-----------------

We welcome contributions in various forms:

- **Reporting Bugs**: Identify and report issues to help us improve.
- **Suggesting Enhancements**: Propose new features or improvements.
- **Submitting Pull Requests**: Contribute code or documentation changes.

Before contributing, please:

1. **Review Open Issues**: Check if your idea or issue has already been discussed.
2. **Discuss Changes**: Open a new issue to propose significant changes and gather feedback.
3. **Fork the Repository**: Create your own copy to work on.
4. **Create a Feature Branch**: Use descriptive names like `feature/add-new-widget`.
5. **Write Clear Commit Messages**: Explain the 'what' and 'why' of your changes.
6. **Submit a Pull Request (PR)**: Provide a clear description and link to related issues.

Code Style Guidelines
---------------------

- **Formatting**: Adhere to `PEP 8 <https://www.python.org/dev/peps/pep-0008/>`__ standards.
- **Testing**: Ensure all new code is covered by tests.
- **Documentation**: Update or add docstrings and relevant documentation.

Documentation Contributions
---------------------------

- **Format**: Use reStructuredText (reST) for documentation.
- **Structure**: Follow existing documentation structure for consistency.
- **Style**: Refer to the `RST guidelines <https://www.odoo.com/documentation/18.0/contributing/documentation/rst_guidelines.html>`__ for formatting.

Code of Conduct
---------------

Please note that this project does not have a formal Code of Conduct. However, we expect all contributors to maintain a respectful and inclusive environment.

Need Help?
----------

If you have questions or need assistance:

- **Open an Issue**: Describe your problem or question.
- **Community Discussions**: Engage with other contributors for support.

We appreciate your contributions and efforts to improve the project!