Contributing Guide

Welcome to contribute to the Galvatron project! Here are the guidelines for participation.

Ways to Contribute

1. Code Contribution

Fork and Clone

  • Fork the Galvatron repository to your GitHub account

  • Clone the repository locally:

git clone https://github.com/your-username/Hetu-Galvatron.git

Create Branch

  • Create and switch to a new feature branch:

git checkout -b feature-name

  • Ensure the branch name reflects the feature you’re developing

Development Guidelines

  • Follow the project’s existing code style and conventions

  • Add appropriate documentation and comments for new features

  • Write necessary unit tests

  • Ensure all test cases pass

Submit PR

  • Push changes to your repository

  • Create a Pull Request to the main repository

  • Describe your changes in detail

  • Link related Issues (if any)

2. Issue Reporting

  • Submit issues using GitHub Issues

  • Provide clear issue descriptions

  • Include steps to reproduce the issue

  • Provide relevant system information and error logs