ilogtail
ilogtail copied to clipboard
How to contribute | 如何参与开源贡献
贡献的方式
欢迎来到 iLogtail 的社区!我们欢迎任何形式的贡献,包括代码、文档及案例。
我们使用标签(label)来进行 Issue 的管理。你可以根据如下标签,提出或选择对应的 Issue 进行社区贡献。对于持续参与贡献的开发者,我们会重点关注并优先发展为 Committer。
- 希望社区参与共建,对应 label: community。
- 适合新手开发,对应 label: good first issue。
- 全新特性开发,对应 label: feature request。
- 现有功能完善,对应 label: enhancement。
- 文档补充、完善(document),对应 label: documentation。
- 配置样例、模版补充(config example),对应 label: config example
如果您的 PR 包含非常大的变更(比如模块的重构或者添加新的组件),请务必发起详细讨论,编写详细的文档来阐述其设计、解决的问题和用途,达成一致后再进行变更。您可以在 Issue 或 Discussions ideas(建议) 中给出详细的设计,具体可参考:designed issue 或 designed discussion。
如何认领 Issue
如果您是初次贡献,可以先从 good first issue 列表中认领一个相对小的任务来快速参与社区贡献。
认领方式: 您可以直接在相应 Issue 中回复参与意愿,然后参照贡献指南解决 issue 并按照规范提交 PR,通过 review 后即可合入到 main 分支。
社区互动
在 Discussions 中交流互动也是对 iLogtail 社区的贡献,您可以在这里回复问题、分享经验,欢迎参与讨论交流。
案例贡献
我们在知乎建立了专栏 iLogtail社区,欢迎大家投稿,分享 iLogtail 的使用案例。同时,对于一些优秀的案例,我们也会在文档库进行链接。目前分为3个板块:
插件文档贡献指南 #272 插件文档规范