Skip to content

Latest commit

 

History

History
69 lines (38 loc) · 4.28 KB

CONTRIBUTING.md

File metadata and controls

69 lines (38 loc) · 4.28 KB

贡献指南

欢迎您为我们的项目做出贡献！请仔细阅读以下指南，以确保您的贡献符合项目的要求。

提交问题或建议

如果您对项目有任何问题、建议或反馈，请通过GitHub的Issue页面提出。在提出问题或建议之前，请确保您已经搜索了现有的Issue，以避免重复。

当提交问题或建议时，请提供清晰详细的描述，包括特定的上下文、错误信息和重现步骤（如果适用）。这将帮助我们更好地理解并解决您的问题。

提交代码

如果您想为项目提交代码，您可以按照以下步骤进行：

  1. 首先，请确保您的代码与项目的风格和约定一致。请参考项目的Code of Conduct文件以及其他代码示例来保持一致。

  2. 在提交代码之前，请先创建一个新的分支，并在该分支上进行修改。这样可以确保您的更改与主分支的其他工作隔离开，并且可以更轻松地进行代码审查和版本控制。

  3. 在提交代码之前，请确保您的更改经过了充分的测试，并且不会引入新的错误。我们鼓励您编写适当的测试用例来验证您的代码。

  4. 当您准备好提交代码时，请创建一个Pull Request（PR）。在PR描述中，请提供清晰明确的说明，解释您的更改的目的和效果。

  5. 您的代码将会进行审查。请耐心等待并参与审查过程中的讨论。根据需要，您可能需要对您的代码进行进一步的修改。

  6. 一旦您的代码通过审查并满足了项目的要求，它将会被合并到主分支中。恭喜您的贡献！

行为准则

  • 尊重和包容他人的意见和观点。
  • 避免使用侮辱性、挑衅性或歧视性的语言。
  • 注意您的言辞，确保您的交流友好和建设性。
  • 如果您遇到任何不当行为或冲突，请立即向项目维护者报告。

感谢您的贡献和支持！我们期待着您的代码、问题和建议，以使项目变得更好。

Contributing Guidelines

Welcome to our project! Please read the following guidelines to ensure that your contributions align with the requirements of the project.

Submitting Issues or Suggestions

If you have any questions, suggestions, or feedback regarding the project, please create an issue on the GitHub Issue page. Before submitting your issue or suggestion, please make sure to search for existing issues to avoid duplicates.

When submitting an issue or suggestion, provide a clear and detailed description, including specific context, error messages, and steps to reproduce (if applicable). This will help us better understand and address your concerns.

Submitting Code

If you would like to contribute code to the project, you can follow these steps:

  1. First, ensure that your code adheres to the project's style and conventions. Refer to the project's Code of Conduct file and other code examples to maintain consistency.

  2. Before submitting your code, create a new branch and make your modifications on that branch. This will ensure that your changes are isolated from other work on the main branch and allow for easier code review and version control.

  3. Prior to submitting your code, make sure your changes have been thoroughly tested and do not introduce new errors. We encourage you to write appropriate test cases to validate your code.

  4. When you are ready to submit your code, create a Pull Request (PR). In the PR description, provide a clear explanation of your changes, their purpose, and their effects.

  5. Your code will undergo review. Please be patient and participate in the discussions during the review process. You may need to make further modifications to your code as needed.

  6. Once your code has passed the review and meets the project's requirements, it will be merged into the main branch. Congratulations on your contribution!

Code of Conduct

  • Respect and be inclusive of others' opinions and viewpoints.
  • Avoid using insulting, provocative, or discriminatory language.
  • Be mindful of your language and ensure your communication is friendly and constructive.
  • If you experience any inappropriate behavior or conflicts, report it immediately to the project maintainers.

Thank you for your contribution and support! We look forward to your code, issues, and suggestions to make the project even better.