Back to Details

key-guidelines

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Key Guidelines

关键指南

Design Principles

设计原则

  • DRY (Don't Repeat Yourself): Avoid code duplication
  • KISS (Keep It Simple, Stupid): Keep designs and code simple
  • YAGNI (You Ain't Gonna Need It): Don't implement features until actually needed. Extract methods/functions only when there's a concrete need for reuse, not in anticipation of it
  • SOLID Principles: Single Responsibility, Open/Closed, Liskov Substitution, Interface Segregation, Dependency Inversion
  • SoC (Separation of Concerns): Separate system by concerns (UI, business logic, data access, etc.)
  • DRY (Don't Repeat Yourself): 避免代码重复
  • KISS (Keep It Simple, Stupid): 保持设计和代码简洁
  • YAGNI (You Ain't Gonna Need It): 除非实际需要，否则不要实现功能。仅在有明确的复用需求时才提取方法/函数，而非预先提取
  • SOLID原则: 单一职责、开闭、里氏替换、接口隔离、依赖倒置
  • SoC (Separation of Concerns): 按关注点分离系统（UI、业务逻辑、数据访问等）

Development Methodology

开发方法论

  • TDD Approach: Use TDD methodology (Kent Beck style) to break down tasks during execution
  • Micro-commits: One change per commit, strictly follow test-driven change cycles (Lucas Rocha's micro-commit methodology)
  • TDD方法: 使用TDD方法论（Kent Beck风格）在执行过程中拆分任务
  • 微提交: 每次提交仅包含一处变更，严格遵循测试驱动的变更周期（Lucas Rocha的微提交方法论）

Quality & Standards

质量与标准

  • Code Quality: Run linters and type checkers before committing
  • Security: Always follow security guidelines and scan for vulnerabilities
  • Documentation: Keep technical documentation in 
    docs/
    directory
  • Version Control: Follow conventional commit messages and branching strategy
  • 代码质量: 提交前运行代码检查工具和类型检查器
  • 安全性: 始终遵循安全指南并扫描漏洞
  • 文档: 将技术文档保存在
    docs/
    目录中
  • 版本控制: 遵循规范的提交信息和分支策略