How to contribute | 如何参与开源贡献

[sczyh30]

贡献的方式

参与社区贡献的方式不局限于代码。任何形式的贡献我们都欢迎，比如：

• 错别字或格式修正（typo fix），对应 label: typo/format
• 文档补充、完善（document），对应 label: area/document
• 回答、解决问题，对应 label: kind/question
• 维护官网（sentinel-website）
• 相关文章、实践经验（Awesome Sentinel）
• 测试用例补充，对应 label: area/test
• 修复 bug，对应 label: kind/bug
• 功能完善、提供新的 feature。对应 label: kind/enhancement 和 kind/feature
• 参与新功能讨论、代码 review
• 多语言版本贡献，如 Sentinel Go

我们鼓励在社区中使用英文交流。

如何认领 Issue

如果您是初次贡献，可以先从 good first issue 或 help wanted 列表中认领一个比较小的任务来快速参与社区贡献。您可以直接在相应 issue 中回复参与意愿，然后参照 GitHub 工作流指引 解决 issue 并按照规范提交 PR，通过 review 后就会被 merge 到 master 分支。

我们也欢迎开发者主动参与维护文档/官网。

如果您希望给 Sentinel 开发新的 feature，可以参考 issue 指南 发起新的 issue，描述新 feature 的背景和特性，发起相关讨论。您也可以通过这两种 label 的 issue：kind/enhancement 和 kind/feature 来了解其它社区开发者提出的 feature / enhancement。

您也可以在 issue 页面搜索感兴趣的相关 issue 来改进。参与社区贡献比较多的开发者，我们会重点关注并优先发展为 committer。

更多详细的贡献指引可以参考 开源贡献指南。

---

How to contribute

Contributions are always welcomed! Please see CONTRIBUTING for detailed guidelines.

Contributions are not limited to code. We welcome any kind of contribution, such as:

• Typo fix or code reformat. Label: typo/format
• Document refinement. Label: area/document
• Answer the questions. Label: kind/question
• Maintain official website of Sentinel (sentinel-website)
• Write blog posts about Sentinel (Awesome Sentinel)
• Test case supplement. Label: area/test
• Fix bugs. Label: kind/bug
• Improve existing features, or develop new features. Label: kind/enhancement and kind/feature
• Participate in new feature discussions and code review
• Polyglot implementations like Sentinel Golang

Start contributing

You can start with the issues labeled with good first issue.