Skip to content

Latest commit

 

History

History
52 lines (40 loc) · 2.54 KB

contributing_guide.md

File metadata and controls

52 lines (40 loc) · 2.54 KB

开源贡献简介

  • 开源意味着开放、协作、公开、透明,大家都可以检查、修改并分享内容。

  • 开源软件按照去中心化、协作的方式发展,依赖社区共同治理;所以开源软件更廉价、更灵活,生命力也更旺盛、持久。

  • 开源社区的理念是:社区高于代码,社区需要多元化。无论你写代码,撰写用户手册、技术博客,设计网站,还是策划社区活动,这些都是在为社区做贡献。

  • 开源社区鼓励大家公开协作,无论你擅长什么,只要你愿意,你都可以在开源的舞台上发光发热。你付出的越多,收获的就越多。

为什么要贡献开源

从个人角度来说,开源就像自助餐中的啤酒一样,意味着免费 - 没有人会为您的拉取请求支付任何费用。但这并不意味着您不能因此受益。通过这种公开透明的协作方式为开源做贡献,你可以

  • 提高个人知名度和影响力
  • 提升履历价值
  • 成为精英管理中的骨干

如何贡献

Apache 软件基金会、CNCF、Linux Foundation 等有成千上万的开源项目,怎么找到合适的项目贡献呢?我们以 Apache 项目为例来介绍如何上手。

  1. 了解 Apache 软件基金会的社区理念,深入了解社区高于代码
  2. 发现问题,并尝试解决
  3. 加入社区:订阅邮件列表、加入项目 Slack、微信交流群,关注项目 Twitter、LinkedIn 等动态。大胆在邮件列表中介绍自己,并积极参与问题讨论。

贡献内容

无论你从事什么职业,为哪个开源项目做贡献,你可以在以下方面充分发挥自己的特长:

  • 写代码
  • 测试
  • 写文档
  • 审校 PR
  • 解决用户问题
  • 设计网站
  • 举办社区活动
  • ......

贡献流程

描述贡献的各个步骤,比如先 fork,再 clone... 等。

详细步骤,可以参考 本项目贡献者指南

示例

Checklist

  • 项目主 repo 的根目录中是否有贡献者指南
  • 项目 readme 中是否提及贡献者指南
  • 贡献者指南中包含如下内容:
    • 欢迎的态度
    • 贡献的内容
    • 贡献的流程
  • 贡献者指南是否简介明了、清晰易懂