File tree Expand file tree Collapse file tree 1 file changed +30
-13
lines changed
Expand file tree Collapse file tree 1 file changed +30
-13
lines changed Original file line number Diff line number Diff line change 1- # 贡献者须知
1+ # TouchFish 贡献者须知 V2
22
3- 为防止你的 PR 被 ~~ 我无情 close ~~ 。请阅读以下贡献者须知后,再开始贡献 :
3+ 感谢你为项目贡献代码!在提交 PR 前,请仔细阅读以下指引 :
44
5- - 除非你只有 1 个 commit,否则一律采用 squash 再 merge 的方式(不是我故意,而是有 bot,commit 过多 bot 会出现冲突问题)
6- - 通常地,竞赛式代码是不准出现在核心代码之中的。运算符两边要留有空格,除非函数中的指定参数调用。变量名一定要有意义,这是工程代码,一个十几个字符的变量名也是可以的。比如建议的写法:` least <= x <= maxium ` ,` grid(column=4) ` 。
7- - ** 无论你改的是 client 还是 server,都要与上一个版本的 client 和 server 兼容。有一个大 PR 就是这么被 close 的。如果你的是较为独立的版本,没法与上一个版本兼容,请转到 TouchFishPlus**
8- - 单份文件代码超出 700 行可以拆出来模块了。
9- - 我们建议以下划线分割单词以命名函数和变量,如 ` exit_flag ` 。
10- - ** 一次最好不要改太多** ,尽量忍住在 100 行内。因为我精力极为有限,出现太多 conflicts 可能直接 close 了。
11- - 确保你的代码能跑,用户合法操作的前提下不会报错,用户不合法操作的前提下尽量做异常处理(这不废话吗)。不要有 bug 除非你的 bug 对实际使用不大,有 bug 在 PR 里标出来。
12- - 改了哪些在 PR 里标出来。
13- - ** 建议的 COMMIT_MESSAGE 格式,[ feat/bug] 你改了啥** ,如果改的东西多 COMMIT_MESSAGE 分多行来写。
14- - ** chat 不要搞可视化,到 5020 年了也给我搞命令行!!!** 。
5+ ## 一、提交与规范
6+ - ** 提交方式** :除非仅有一个 commit,否则使用 squash 方式合并
7+ - ** CI 处理** :如果你正在提交文档,请在提交标题前加上 ` [skip ci] ` 以跳过 Actions
8+ - ** 代码风格** :
9+ - 运算符两侧需保留空格(函数指定参数除外,如 ` grid(column=4) ` )
10+ - 变量名应具有描述性,推荐使用下划线分隔,如 ` exit_flag `
11+ - ** 代码结构** :单文件超过 800 行时应考虑拆分为独立的模块
12+ - ** 修改范围** :每次修改请控制在 200 行以内,大幅改动请拆分多个 PR
1513
16- 应该就这些,想起来再改。
14+ ## 二、测试与质量
15+ - ** 测试覆盖** :每次提交必须保证测试覆盖(文档类修改除外)
16+ - ** 兼容性要求** :必须保持向后兼容,无法兼容的修改请提交至 Plus 仓库
17+ - ** 代码质量** :
18+ - 确保代码正确运行,合法操作不报错
19+ - 对非法操作进行恰当的异常处理
20+ - 如存在不影响使用的已知问题,请在 PR 中明确说明
21+
22+ ## 三、审核与合并
23+ - ** PR 描述** :清晰列出修改内容,建议使用 ` [feat/bug/docs] 简要描述 ` 的格式
24+ - ** 标签使用** :建议为修改添加标签(Bug/Feature/Document)
25+ - ** 协作规范** :
26+ - 请勿 @ 提及未参与本次 PR 的成员
27+ - 请勿频繁催促审核
28+ - ** 合并流程** :当 PR 被标记为 ** Action: Merge** 时,表示即将合并
29+
30+ ## 四、关于服务端的说明
31+ - ** 界面要求** :服务端(` chat.py ` 和 ` admin.py ` )请保持命令行界面,不接受可视化改动(部分发行版的 admin 除外)
32+
33+ 感谢你的理解与配合,我们期待看到你的精彩贡献!
You can’t perform that action at this time.
0 commit comments