Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (25 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

46 lines (25 loc) · 1.89 KB

English | 简体中文 | Português (Brasil) | Türkçe

Contributing Guide

Thank you for your interest in contributing to this project! Please follow the steps below to get started:

How to Contribute

  1. Fork this repository

    Click the Fork button at the top right corner to fork this project to your GitHub account.

  2. Create a branch

    Clone your fork locally and create a new branch based on main for your development. Suggested branch names: feature/xxx, fix/xxx, etc.

  3. Make changes

    Keep your commit history clear and concise. Please write meaningful commit messages for each change.

  4. Push your branch and open a Pull request

    Push your branch to GitHub and open a Pull request (PR) in this repository. Please describe your changes and the motivation in detail in the PR description.

  5. Code review

    Maintainers will review your PR and may suggest changes. Please respond promptly and make adjustments as needed.

  6. Merge and release

    After approval, maintainers will merge your changes. Your contribution will appear in the next release.

Contribution Tips

  • Follow the project's code style and conventions.
  • Ensure local build and tests pass before submitting.
  • Update relevant documentation if your changes affect docs.
  • For large or breaking changes, discuss first in Issues.

Reporting Issues

To report bugs or suggest new features, please submit them in Issues with as much detail as possible (logs, screenshots, etc.).

Contact

If you have questions, contact us via Issues or Discussions.