pythoncamp0

提交指南

  • 每次提交只修复一个问题

    每次提交限定于完成一次逻辑功能。并且适当地分解为多次小更新,以便每次小型提交都更易于理解。便于其他开发者复阅,也方便自己将来取消某个特定问题的修复。最终得到一个干净有意义,且易于理解的提交历史。

  • 提交说明的撰写

    写得好可以让大家协作起来更轻松。一般来说,提交说明最好限制在一行以内,50 个字符以下,简明扼要地描述更新内容,空开一行后,再展开详细注解。Git 项目本身需要开发者撰写详尽注解,包括本次修订的因由,以及前后不同实现之间的比较,我们也该借鉴这种做法。另外,提交说明应该用祈使现在式语态,比如,不要说成 “I added tests for” 或 “Adding tests for” 而应该用 “Add tests for”。

参考文档

团队合作入门

为项目作贡献