Skip to content

Latest commit

 

History

History
34 lines (26 loc) · 1.72 KB

File metadata and controls

34 lines (26 loc) · 1.72 KB

TouchFish 贡献者须知 v2.1

感谢你为项目贡献代码!在提交 PR 前,请仔细阅读以下指引:

一、提交与规范

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

二、测试与质量

  • 测试覆盖:每次提交必须保证测试覆盖(文档类修改除外)
  • 兼容性要求:必须保持向后兼容,无法兼容的修改请提交至 Plus 仓库
  • 代码质量
    • 确保代码正确运行,合法操作不报错
    • 对非法操作进行恰当的异常处理
    • 如存在不影响使用的已知问题,请在 PR 中明确说明

三、审核与合并

  • PR 描述:清晰列出修改内容,建议使用 [feat/fix/doc] 简要描述 的格式
  • 标签使用:建议为修改添加标签(Bug/Feature/Document)
  • 协作规范
    • 请勿 @ 提及未参与本次 PR 的成员
    • 请勿频繁催促审核
  • 合并流程:当 PR 被标记为 Action: Merge 时,表示即将合并

感谢你的理解与配合,我们期待看到你的精彩贡献!