Skip to content

Latest commit

 

History

History
67 lines (42 loc) · 3.67 KB

contribution-guidelines.md

File metadata and controls

67 lines (42 loc) · 3.67 KB
Raw

Contribution Guidelines

Englis | 简体中文

Contributions to this project are very welcome. Here are some guidelines and suggestions to help you get involved in the project.

Contributing Code

If you want to contribute to the project, the best way is to submit code. Before submitting code, please ensure that you have downloaded and familiarized yourself with the project code repository, and that your code adheres to the following guidelines:

  • The code should be as concise as possible, and easy to maintain and expand.
  • The code should follow the naming convention agreed by the project to ensure the consistency of the code.
  • The code should follow the code style guide of the project, and you can refer to the existing code in the project code library.

If you want to submit code to the project, you can do so by following these steps:

  • Fork the project on GitHub.
  • Clone your forked project locally.
  • Make your modifications and improvements locally.
  • Perform tests to ensure that any changes have no impact.
  • Commit your changes and create a pull request.

Code Quality

We attach great importance to the quality of the code, so the code you submit should meet the following requirements:

  • Code should be fully tested to ensure its correctness and stability.
  • Code should follow good design principles and best practices.
  • The code should conform as closely as possible to the relevant requirements of your submitted code contribution.

Submit Information

Before committing code, please ensure that you provide a meaningful and detailed commit message. This helps us better understand your code contribution and merge it more quickly.

Submission information should include the following:

  • Describe the purpose or reason for this code contribution.
  • Describe the content or changes of this code contribution.
  • (Optional) Describe the test methods or results of this code contribution.

The submission information should be clear and consistent with the submission information agreement of the project code base.

Problem Reporting

If you encounter problems with the project, or find bugs, please submit an issue report to us. Before submitting an issue report, please ensure that you have thoroughly investigated and experimented with the issue and include as much of the following information as possible:

  • Describe the symptoms and manifestations of the problem.
  • Describe the scenario and conditions under which the problem occurred.
  • Describe contextual information or any relevant background information.
  • Information describing your desired behavior.
  • (Optional) Provide relevant screenshots or error messages.

Issue reports should be clear and follow the issue reporting conventions of the project's codebase.

Feature Request

If you want to add new functionality or features to the project, you are welcome to submit a feature request to us. Before submitting a feature request, please make sure you understand the history and current state of the project, and provide as much of the following information as possible:

  • Describe the functionality or features you would like to add.
  • Describe the purpose and purpose of this function or feature.
  • (Optional) Provide relevant implementation ideas or suggestions.

Feature requests should be clear and follow the feature request conventions of the project's codebase.

Thanks for your contribution

Finally, thank you for your contribution to this project. We welcome contributions in all forms, including but not limited to code contributions, issue reports, feature requests, documentation writing, etc. We believe that with your help, this project will become more perfect and stronger.