贡献指南(Contributing Guide)

感谢你有兴趣为K-NET项目做出贡献!
为了保持项目质量和协作高效,请在提交代码或问题前仔细阅读以下内容。


🧩 1. 如何参与

我们欢迎所有形式的贡献,包括但不限于:

  • 报告 bug
  • 提出新功能建议
  • 提交代码修复或改进
  • 改进文档或示例

🧠 2. 如何提交与处理 Issue

K-NET的代码仓库中,点击工具栏的 “Issues”,您可以找到其Issue列表。提交新问题或建议前,先确认以下几点:

✅ 没有重复的 Issue,请先搜索已有的 Issue,避免重复报告。

💬 提供充分的上下文信息,这有助于维护者快速定位问题。

提交 Issue

  • 如果您准备上报Bug或提交需求,为K-NET贡献自己的意见或建议,可以在K-NET仓库上提交Issue(请参考 Issue 提交指南 )。

处理 Issue

  • 如果您愿意处理其中的一个 Issue,可以将它分配给自己。只需要在评论框内输入/assign/assign @yourself,机器人就会将Issue分配给您,您的名字将显示在负责人列表里。

🧑‍💻 3. 如何贡献编码

搭建环境

  • 如果您想参与编码贡献,需要准备K-NET的开发环境,请参考README.md内容搭建开发环境并执行示例

下载代码及新建分支

  • 您还需要了解如何在 Gitcode 下载代码,通过 PRPull Request) 合入代码等。K-NET 使用 Gitcode 代码托管平台,想了解具体的指导,请参考 Gitcode Workflow Guide 。该托管平台的使用方法类似GitHub,如果您以前使用过GitHub,本节的内容您可以大致了解甚至跳过。

本地修改及验证

  • 在本地分支完成修改后,参考README.md内容进行构建和本地验证,并将修改推送至远程仓库

提交PR (Pull Request)

❤️ 4. 联系与支持

如果您有任何疑问或讨论,或是发现了本指南的不足,欢迎提交Issue的方式告知我们!感谢您对这个项目的贡献!