@@ -82,7 +82,7 @@ $git push origin travis-pep # 提交你的代码到你自己的仓库(origin)
82
82
83
83
但是为了保证项目质量, 要满足以下几条. 请好好看这篇文章[ 如何写就完美 Pull Request] ( http://segmentfault.com/a/1190000002575050 ) . 简单的说:
84
84
85
- 提交pr的时候, 如果是修改其他的人的代码, 甚至可以直接@到对方
85
+ 提交pr的时候, 如果是修改其他的人的代码, 甚至可以直接@到对方, 也可以直接@社区内的任何成员.
86
86
87
87
1 . commit massage里面要对你做的事情有描述, 多个commit的原因是** 出现问题我能对你的单个commit revert**
88
88
2 . commit massage不能有无聊的信息, 比如 ` test ` , ` 1 ` , ` qwert ` 这些. 请仔细写
@@ -113,13 +113,22 @@ PS: 大家注意不要强加你认为正确地方式给别人, 有些东西属
113
113
这个期间提交pr的人比较惨. 尤其是团队初期, 没有了解大家的胃口的时候, 做好足够的心理素质. 这不是在故意针对.
114
114
这些东西在你以后会产生非常好的影响, 给你养成非常好的代码习惯. 这比看书看别人的东西来的容易, 写的容易哦
115
115
116
+ ** pr的标题**
117
+
118
+ pr还有2种特殊的用法:
119
+
120
+ 1 . [ NM] - not merge 表示现阶段不要把这个PRmerge进来
121
+ 2 . [ WIP] - work in process. 表示在进行中, 或者发现了什么bug在修改. 也不要merge. 可以先代码review.
122
+
123
+ 如果标题包含以上2种用法, 大家可以定期ping原作者. 看要不要修改状态或者关闭掉
124
+
116
125
##### 合并/拒绝代码
117
126
118
127
我们没有暂缓搁置这个方式. 要不然会merge到master,要不然给出理由拒绝.
119
- 为了保证社区初期的基调, 目前权限只有我一个人, 未来在看到大家能热情和能力之后我会放开.
120
128
121
129
1 . 我会尽量快得做出回应.
122
130
2 . 我自己的PR我会放一天以上的时间, 希望大家也来吐槽我
131
+ 3 . 提交的代码, 最后不是本人来merge. 包括我的. 我希望不会存在只有一个人熟悉某一块的代码.
123
132
124
133
假如你的代码被合并了, 恭喜你成为社区贡献者的一员. 在未来说不定会有些特权或者优先提要或者参与活动会发通知之类的事情.
125
134
假如你的代码被拒绝了. 请不要气馁. 我在给其他知名项目和python标准库贡献代码的时候其实被吐槽多次, 也被拒绝/搁置了很多, 说起来一把辛酸一把泪.
@@ -146,6 +155,10 @@ PS: 大家注意不要强加你认为正确地方式给别人, 有些东西属
146
155
* 当某段代码有很多计算或者写的逻辑很复杂, 请在这段代码简要介绍下用途,
147
156
让其他开发者不需要了解这段代码就知道它的输入和输出(就算是维护这段代码也能有个大概的了解意图)
148
157
158
+ ** TODO/FIXME**
159
+
160
+ 注释中可以添加TODO/FIXME这样的标签, 把坑留到下一步或者别人来解决. 给未来的执行者有一个比较好的说明.
161
+
149
162
### python3支持
150
163
151
164
目前除了一些激进的组织,大部分还是使用python2. [ PEP404] ( https://www.python.org/dev/peps/pep-0404/ ) 说不会有官方的2.8. 2.7.914年底也已经release了.
0 commit comments