[Attention] Contribution Process | 贡献流程
mo3et opened this issue · 0 comments
mo3et commented
- 先创建一个 issue 讲明现在要做的事情,并寻求其他成员的意见。必须要讨论沟通达成一致,确认无误后,才开始进行开发工作。
- 编码完成后进行代码的审核,同时并进行规范化操作,例如
make format
格式化代码,make lint
检测代码质量. - 提起 Pull Request 时按照 description 内的提示进行内容填写,并在 Which issue(s) this PR fixes 这部分通过
#<issues-number>
引用,例如#103
#103 - 维护者确认无误审核通过,合并该 PR 到分支里,流程结束。
- 有疑问的地方也可以向维护者寻求帮助。
- 维护者在确认 issue 无误可以展开工作时,需要在对应 issue 做出回应。例如 LGTM. 或者 Approve this issue.
开发注意
- 在开始写代码之前先想好大概的解决方案,最好能够在群里发布一个提案,让大家来看看方案有没有问题。如果有问题提出来,必须要讨论沟通达成一致。确认没有问题之后,就可以进行开发工作。
- 避免代码写完进行PR的时候,跟大家的想法有较大差异,导致PR不通过而无奈返工,浪费大量时间和精力。
- 如果发现自己的精力有限,难以进行下去,请尽快将任务抛出来交给其他人承接,避免拖慢进度。
- 对于比较通用的组件(函数、方法等),把这些组件抽离出来,放到顶层目录下的pkg目录中。
- 开发中途有任何疑惑都可以在(群里)问出来,不怕你问题多,就怕你不问。