Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (36 loc) · 3.07 KB

CONTRIBUTING.md

File metadata and controls

49 lines (36 loc) · 3.07 KB

Contributing to HEonGPU

Thank you for your interest in contributing to HEonGPU! We greatly appreciate your time and effort. The following guidelines will help streamline the contribution process and ensure that HEonGPU continues to grow efficiently.

How You Can Contribute

1. Reporting Bugs

  • Open an Issue: If you discover a bug, please create an issue in the GitHub repository.
  • Include Detailed Information:
    • Steps to reproduce the bug
    • Expected behavior vs. actual behavior
    • Your environment details (e.g., OS version, GPU model, HEonGPU version)
    • Any relevant logs, error messages, or screenshots

2. Suggesting New Features

  • Feature Requests: Feel free to suggest new features or enhancements by opening an issue.
  • Describe Your Idea: Provide a clear explanation of the feature and the problem it solves. If possible, suggest implementation details.

3. Improving Documentation

  • Documentation Contributions: If you find errors or have suggestions for improvement, make the necessary changes and submit a pull request.
  • Examples: We encourage you to add examples or expand existing sections to make documentation clearer and more helpful.

4. Submitting Code Changes

  • Fork and Clone: Start by forking the repository and cloning it locally.
  • Create a New Branch: Work on your changes in a new branch named descriptively (e.g., fix-bug-456, feature-xyz).
  • Write Tests: Ensure you write unit tests to cover your changes, and make sure all tests pass.
  • Format Your Code: We maintain consistent code formatting using clang-format. Run clang-format-all from the dev-tools directory before committing.
$ ./dev-tools/clang-format-all <PATH>
  • Commit Message Guidelines: Write clear and descriptive commit messages. Explain what the change does and why it is needed.

5. Creating a Pull Request

  • Keep Your Branch Up-to-Date: Regularly sync your branch with main to avoid conflicts.
  • Open a Pull Request (PR): When your code is ready, open a pull request to the main branch. Include a detailed description of your changes and any relevant issue numbers.
  • Be Responsive: Reviewers may ask for changes or provide feedback. Be prepared to discuss and make adjustments as needed.
  • Resolve Conflicts: If your PR develops merge conflicts, address them promptly to keep the review process moving.

Staying Up-to-Date

To stay informed about updates and new releases, consider starring the repository on GitHub. By starring, you will receive notifications and be able to easily keep track of changes.

License

By contributing to HEonGPU, you agree that your contributions will be licensed under the same license as the project. Make sure to review the LICENSE file in the repository for details.

Thank You!

Thank you once again for considering contributing to HEonGPU! Your contributions make a big difference, and we are grateful for your support and collaboration. If you have any questions or need guidance, feel free to reach out through GitHub issues or discussions.