From 8d248466ebf878e12c36c4207a60d8c8267ca50f Mon Sep 17 00:00:00 2001 From: MrKBear Date: Fri, 31 Dec 2021 14:17:52 +0800 Subject: [PATCH] Update ReadMe file --- README.md | 29 ++++++++++++++++++++++++++--- 1 file changed, 26 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b57f570..821398e 100644 --- a/README.md +++ b/README.md @@ -48,12 +48,35 @@ 3. 更好的拓展性,加入更多大家喜欢的功能 +新功能: + +1. 正在讨论设计,等待你的建议... + ## 社区贡献规范 +请仔细阅读! +### 项目贡献流程 + 请先邮件联系 ```mrkbear@mrkbear.com``` 获得 Gitea 平台账号 -在仓库中创建自己的分支,分支命名规范为 ```dev-你的昵称``` +在仓库中创建自己的分支,分支命名规范为 ```dev-你的昵称```,例如 ```dev-mrkbear``` -克隆此储库,在本地 ```checkout``` 到自己的分支 +克隆此储库,在本地 ```git checkout dev-你的昵称``` 到自己的分支,进行改动。 -开发完成后 ```push``` 到自己的远程分支,并发起合并请求,等待 review +开发完成后 ```git push``` 到自己的远程分支,并发起合并请求到 ```master``` 分支 + +发起合并请求时,需要指派给 ```MrKBear``` 进行代码审核,审核通过后,代码将完成合并。 + +### 注意事项 + +1. ```master``` 分支处于保护状态,仅通过合并请求进行修改 + +2. 代码提交时,请使用清晰明确的 ```message``` + +正例: ```Add timetable page``` 反例: ```阿巴阿巴阿巴阿巴``` + +3. 请勿将任何个人隐私信息以任何方式,放入代码中 + +4. 为保证 CI/CD,提交代码前必须保证编译可以通过 + +5. 一个文件不要超过 1000 行代码,尽量保证代码可读性 \ No newline at end of file