Skip to content

[ADD] add submission code process #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 16, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions doc/submitcode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@

# HelloGitHub 提交代码流程

## 寄语
- 遵守 HelloGitHub 开发规范
- 及时沟通, 在适当的时候(需求有疑问,或者开发过程中遇到难题,努力后解决不了都可以沟通)寻求 Team 成员帮助
- 不合理或者没有涉及到的后续补充完善

**注意:**
新加入的成员:结合项目文档, 自行阅读项目源码, 熟悉项目开发使用的技术栈

## 一、代码开发前准备
#### 基本要求
- 有 GitHub 或 GitLab 代码管理平台的账号
- 熟悉 git 命令
- 使用统一的 IDE 开发工具 Pycharm

#### 开发要求:
1. 根据提出的需求,沟通理解需求
2. 在 [HelloGitHub 的开源地址](https://github.com/521xueweihan/HelloGitHub/projects/1) 处登记,登记需求名称,任务进度,开始时间,计划完成时间
3. 在源码处新创建一个 branch,依赖 dev 分支(目的:方便最后 review 能看见所有最终版代码)
- branch 命令原则:feature_xx(xx 跟需求有关)

## 二、代码开发规范
**开发前:**
- pull 新建的分支 feature_xx
- pull 最新代码,避免版本冲突
- 开发接口前,先写接口开发文档,整理思路(参考已有的项目文档和接口文档)

**开发中:**
*所有成员:*
- 遵守接口默认开发规范,遵守 HelloGitHub 定义的接口开发规范(参考接口文档)
- 必要的注释
- 关注权限部分
- 自查,提交最优代码
- push 填写 git commit,描写本次代码提交的内容,规范如下:
- [ADD] 增加的新功能前加上此标志
- [IMP] 完善功能前加上此标志
- [FIX] 修复功能 bug 前加上此标志
- [DEL] 删除功能前加上此标志
- 同步更新接口文档
- 检查开发的是否跟需求一直, 是否遗漏

*管理员:*
- review
- 优化,优化,优化 。。。
- merge
- 删除该需求分支 feature_xx

## 三、开发后期协作
- 在 [HelloGitHub 的开源地址](https://github.com/521xueweihan/HelloGitHub/projects/1) 处修改此需求的进度
- 完成后最好微信群通知相关人员(包括前端、后端、运营等)