如何更好的使用GitHub

注册 github 一百多天，逐渐被这个强大的同性交友社区所吸引，这里的开源精神影响着我，我想就如何更好的使用简单谈谈自己肤浅的认识。

我的新书《LangChain编程从入门到实践》 已经开售！推荐正在学习AI应用开发的朋友购买阅读！

Watch|Star|Fork是什么

• 当你访问一个仓库的时候，会遇到三个按钮：Watch（关注） / Star（星标） / Fork（分支）。

1. Watch 表示关注，当出现新的 issue 会自动发一个页面通知，并往注册邮箱发送一封邮件。顺便一提，当 watch 的仓库过多的时候，通知邮件可能会塞满邮箱，除了在自己的邮箱设置过滤规则外，可以在通知设置界面禁止这些通知。
2. Star 表示收藏，对认为不错的仓库进行标注，说不定哪天用到里面的轮子，这就能通过 Your stars 页面来快速找到这些项目了。它经常被用做对项目表达支持的投票（官方也提倡如此）。
3. Fork 两种作用：一种是为它提交代码；一种是觉得这个仓库可能会被删掉，Fork 出来作为备份，但不会随着原始仓库自动更新。

   开源自己的库

• 仓库中包含一个明确的 LICENSE 文件，选择自己认为适合的开放协议（下面有一个阮大的图）。
  
• 文档类的仓库通常会选择 CC(允许商用) 或 CC-BY-NC(不允许商用或商用时需单独授权) 协议。
• 帮助别人更好的加入，为 issue 和 PR 提供模板。
• 不要随意废弃已经开源的仓库，如果废弃，最好写个 README 来告诉别人后序或原因。

  为别人的库提交代码

  提 issue

• 提 issue 也就是提问题，基本要求是确认它是问题(尴尬的是自己不会用，而不是代码本身的 BUG:hear_no_evil:)，并把问题说清楚。

  提 PR

• Pull Request（简称 PR）也就是申请往主库中合并代码，提 PR 之前先 Fork 对方的仓库，Fork 之后，你的个人仓库中就有了一个分支仓库，你可以往这个分支仓库中提交代码，觉得达到了 PR 的预定目标之后，就推送它，并回到 GitHub 页面中发起 PR（GitHub 会在页面上主动提示可以发 PR）。
• 提 PR 的基本要求是达到对方的代码质量标准(测试覆盖率，代码中使用内联注释来生成文档等)。

  贡献的形式有两种：提 issue 和 提 pull request。

1. 认真读 issue 和 PR 模板。
2. 及时跟进问题。如果觉得对方的答复已经解决了你的问题，就及时关闭，
3. 尽量用英语提，除非是中文仓库。

   最后

• 推荐读读Redis维护者的挣扎和无奈，看我们自己能为开源做什么吧。