Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

47 lines (30 loc) · 1.5 KB

Contribution Guidelines

Welcome to contribute to this repository! Your help is greatly appreciated and here are some suggestions and guidance to ensure the contribution goes smoothly.

Contribution mode

You can contribute by:

  1. Reporting problems： Found an error or improvement in the documentation? Please create an Issue to report the problem.
  2. Propose improvements： If you have suggestions for this project, send us through an issue.

Report problems and make recommendations

  1. Please create a new Issue in the Issues page.

  2. Select the appropriate label, such as "bug" or "enhancement".

  3. Provide clear and detailed instructions, including steps to reproduce the problem (if reporting the problem) or your suggestions.

Submit Pull Request

  1. Fork the repository and clone its main branch locally:

    git clone -b develop https://github.com/your-username/your-repo-name.git

  2. Make changes in this directory

  3. Commit your changes

    git add .
git commit -m "Add/modify your-documentation"

  4. Push to your forked remote repo

    git push origin feature/your-feature

  5. Create a Pull Request (PR) :

  • Go to your forked repository and click "New Pull Request".
  • Select the target branch to which your changes should be merged.
  • Provide clear and concise PR descriptions.
  1. We will review your PR and make suggestions or request changes if needed.