.. _contributing:

Contributing to HEonGPU
=======================

Thank you for your interest in contributing to **HEonGPU**! The following guidelines will help streamline the contribution process.

How You Can Contribute
----------------------

**1. Reporting Bugs**
    Open an issue on GitHub with detailed information: steps to reproduce, expected vs. actual behavior, and environment details (OS, GPU, library version).

**2. Suggesting New Features**
    Open an issue to suggest enhancements. Provide a clear explanation of the feature and the problem it solves.

**3. Improving Documentation**
    If you find errors or have suggestions for improvement, make the necessary changes and submit a pull request.

**4. Submitting Code Changes**
    * Fork the repository and create a new, descriptive branch.
    * Write unit tests to cover your changes.
    * Format your code using `clang-format` by running the script in the `dev-tools` directory.
    * Write clear and descriptive commit messages.

**5. Creating a Pull Request**
    * Keep your branch up-to-date with `main` to avoid conflicts.
    * Open a pull request to the `main` branch with a detailed description of your changes.
    * Be responsive to feedback from reviewers.

License
-------

By contributing to HEonGPU, you agree that your contributions will be licensed under the Apache License.