Skip to content

更新 CONTRIBUTING.md #77

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.

Sign up for GitHub

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

Open
JohnChiao75 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

更新 CONTRIBUTING.md #77

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@
## 一、提交与规范

- **提交方式**：除非仅有一个 commit，否则使用 squash 方式合并
- **CI 处理**：如果你正在提交文档类等不影响主程序功能的内容，请在提交标题前加上 `[skip ci]` 以跳过 Actions
- **CI 处理**：如果你正在提交文档类等不影响主程序功能的内容，请在提交标题前加上 `[skip ci] ` 以跳过 Actions
- **代码风格**：
- 运算符两侧需保留空格（函数指定参数**除外**，如 `grid(column=4)`）
- 变量名应具有描述性，推荐使用下划线分隔，如 `exit_flag`
- **代码结构**：~~单文件超过 800 行时应考虑拆分为独立的模块~~ 建议拆模块，但是因为难度较大所以可做可不做，不做硬性要求。
- **修改范围**：每次修改请控制在 200 行以内，大幅改动请拆分多个 PR
- **修改范围**：每次提交请控制在 +/-200 行以内，大幅改动请拆分多个 PR
- **界面要求**：请保持命令行界面，不接受可视化改动

## 二、测试与质量

- **测试覆盖**：每次提交必须保证测试覆盖（文档类修改除外）
- **兼容性要求**：必须保持向后兼容，无法兼容的修改请提交至 Plus 仓库
- **兼容性要求**：必须保持大版本内向后兼容，如果要创建一个大版本，清先考虑加入当前大版本 Issue
- **代码质量**：
- 确保代码正确运行，合法操作不报错
- 对非法操作进行恰当的异常处理
Expand Down