rules.md 1.9 KB

引导

  • 这不是一个标准 Laravel 项目,不要用 Laravel 的思维进行开发
  • Validation不是Validator,有本质区别,阅读 ucore/Validation/README.md 了解
  • 执行命令时避免使用&&进行批量操作
  • 使用目录(往目录里增加/修改/删除文件)先阅读目录的README.md

开发流程

  1. 阅读已有代码,理解需求
  2. 提出开发方案,
  3. 用户确认方案
  4. 进行开发

枚举规范

  • 文件名/类名/case名采用全大写下划线命名

严格遵守的规则

  • 任何操作(增加,删除,修改,执行)执行前都要验证该操作是否符合规则
  • 不要用你以为来进行判断,多阅读现有代码,每涉及一个新类都要去阅读代码了解它

Git提交流程

  • git status查看变更的文件
  • 查看变更的内容,根据变更内容编写commit message
  • 提交,推送

其他规则

  • php artisan migrate禁止使用
  • php artisan migrate:*禁止使用
  • 数据库配置是正确的,不要质疑
  • 数据库的结构变化不采用迁移文件,数据库的结构变化需要人工执行,提供SQL
  • 不使用 migrate,不使用 Migration
  • 模块化开发,所有内容都要在模块文件夹内(Handler除外);单元测试要写在模块中,单元测试备注测试内容
  • 单元测试,不使用RefreshDatabase/DatabaseTransactions来处理数据库,不处理测试数据,允许了测试数据留存
  • Repository是给后台用的,非后台操作不使用
  • 不要臆测一个文件的存在,使用前进行查证,后使用
  • 工作前,查看环境,了解已有内容(阅读整个模块的现有文件列表,阅读需要了解的文件全文),可用内容,需要补充内容
  • 不要臆想内容,先查证,后使用
  • 遇到不好判断的内容,向用户发起提问,多向用户沟通
  • 验证每一个要用到的类的存在和内容
  • 阅读每一个涉及的类,了解内容后再使用