Skip to content

Latest commit

 

History

History
63 lines (41 loc) · 2.01 KB

CONTRIBUTING.md

File metadata and controls

63 lines (41 loc) · 2.01 KB

timewatch 贡献指南

感谢您对timewatch的兴趣和愿意为其做出贡献!我们非常欢迎来自社区的贡献,无论是代码、文档、问题报告还是其他形式的改进。请遵循以下准则和步骤,以确保贡献的顺利进行。

贡献类型

我们欢迎以下类型的贡献:

  • 代码改进和修复
  • 功能请求
  • 文档改进
  • 测试案例
  • 翻译
  • 其他相关改进

贡献流程

  1. 克隆项目的代码库:
$ git clone https://github.com/DanPlayer/timewatch
  1. 创建新的分支:
$ git checkout -b your-branch-name
  1. 进行所需的改进和更改。

  2. 提交拉取请求(Pull Request):

    • 确保您的代码符合我们的代码规范和风格指南。
    • 在提交之前运行适当的测试,并确保所有测试通过。
    • 请提供清晰的说明和上下文,以便我们更好地理解您的贡献。
  3. 等待代码审查和反馈。我们会尽快对您的拉取请求进行审查,并提供反馈或建议。

  4. 完成代码审查和测试后,您的拉取请求可能会被合并到主要分支中。

代码规范和风格指南

  • 请遵循项目的代码规范和风格指南,以确保代码的一致性和可读性。
  • 在贡献之前,请务必阅读项目的 CONTRIBUTING.md 文件以获取详细的代码规范说明。

文档编写指南

  • 我们非常欢迎对文档的改进和修复。
  • 请确保文档的准确性、清晰度和易读性。
  • 在贡献之前,请参考项目的文档结构和风格。

社区交流规范

  • 我们鼓励友好、尊重和包容的社区交流。
  • 请遵循行为准则,尊重他人并避免不当言论。

提示如何报告问题

  • 如果您发现问题或错误,请尽可能详细地描述问题,并提供重现步骤和环境信息。
  • 我们鼓励使用 GitHub Issues 进行问题报告,并请使用适当的模板。

感谢您的贡献

感谢您对项目名称的贡献!我们真诚地感