本文介绍如何开始参与开发松饼。

不怕神对手，只怕猪队友——我们希望所有的项目参与者都能认真读完本文。

1. 关于 Git

松饼开发者必须熟悉Git。 如果没听说过、或不熟悉Git，可参考松饼官方推荐的 Git 学习路线。

2. 关于 Gitter

松饼开发者之间通过 Gitter 交流。

Gitter 是一个聊天工具。 由于支持 Markdown 语法，并且可以和各类开发工具联动， 所以很适合有关编程的讨论。 Gitter 有网页版、桌面版、手机版，基本上什么系统都支持。

3. 项目构成

「松饼」总共包含四个项目：核心库、客户端、服务器、主站。 四个项目关系如图。

松饼项目组成

大多数人关心的麻将、技能部分对应的是核心库libsaki。

GitHub 地址：

4. 开发环境的搭建步骤

见 搭建开发环境 页面。

5. 大致工作流程与审查标准

  • 第一步，从develop创建新分支
  • 第二步，写代码，测试结果
  • 第三步，提交并上传
  • 第四步，创建合并至devleop分支的 pull request 并等待审查
  • 第五步，根据审查结果修改代码，提交上传并等待再次审查
  • 重复第五步直到分支被合并

明文审查标准：

除明文标准外，还会有基于常识的考虑要素。