贡献指南

概述

Kuikly社区致力于打造一个开放、包容、充满活力的跨端开发社区，为开发者提供全方位的交流、学习和协作平台。希望依靠社区的力量，推动Kuikly框架及其生态系统的持续演进。

贡献是开源社区的生命力源泉，Kuikly社区欢迎并鼓励所有形式的贡献。您的每一次贡献，无论是解决Bug、开发功能、共享组件、改进文档、还是分享经验，帮助社区中的其他人，都是对社区的宝贵贡献。 这些贡献不仅帮助Kuikly变得更加完善和强大，也使您自身获得技术成长、行业认可和社区影响力。

贡献代码

寻找合适的任务：新手可以从带有"good first issue"标签的问题开始，这些问题通常专门为新手贡献者设计，难度较低。 也可以查看带有"Help Wanted"标签的issue参与贡献。

设置开发环境：在开始编码前，请先阅读README 源码编译指引，确保您的本地环境能够正确构建和测试Kuikly。

Fork仓库：在正式修改代码前，请先Fork仓库，在Fork的仓库进行编码、测试。

代码规范与质量：Kuikly遵循Kotlin官方代码规范，请在提交前确保代码风格一致。新增功能应包含适当的测试用例，确保功能稳定性和长期维护性

提交Pull Request：PR应包含清晰的目的描述、相关Issue链接、测试计划和任何可能影响的范围。请确保您的提交信息遵循Contribution Guide约定格式，如"feat: 添加新组件"、"fix: 修复XX问题"等

贡献组件

开发基于Kuikly的通用组件或业务组件，贡献到社区生态仓库。优质组件可能被纳入官方推荐生态，获得更多曝光和使用。

组件交流：Kuikly在Github Discussion增加了社区生态讨论区。关于组件的需求、组件的维护问题等在这里进行交流、讨论。

组件分享：社区提供了中心化收集Kuikly组件的方式，共享的组件按照Kuikly-third-party指引，上架到组件市场。

知识分享

社区生态离不开丰富的技术实践分享，通过分享自己的见解，并借鉴他人的经验，我们可以互相学习，共同进步。 技术分享不限于篇幅，大到技术方案、小到解决某个具体问题的心得，都欢迎随时共享到社区。

三方社区分享：开发者首先在自己的渠道，比如个人博客、三方技术社区(掘金、CSDN、知呼等)发表文章。知识分享采用去中心化分享，中心化收集展示的管理方式，这样既方便贡献者通过自己的渠道分享，也方面社区开发者查阅。

分享收集：三方社区分享后，可按照Kuikly-third-party指引，共享到Kuikly社区。

文档与知识库贡献

文档位置：Kuikly文档位于项目docs目录。文档以markdown文件格式编写。如果需要增加图片，请将图片存放在对应目录下的img文件夹下。

增删导航栏：文档首页的导航栏的配置在docs/navbar/zh.ts文件。如果新增导航栏条目，需同时在该文件增加入口文件描述。

增删文档：如果是在某个导航栏条目下增删markdown文件，请同步在docs/sidebar/zh.ts文件，同步进行配置更新。