MyCRM v0.0.1 - Code Review Checklist

Objective

Practice source code management skills on Git Server.

Repository

Repo: <student provides MyCRM Git link>

Tag: v0.0.1 (optional)

  • No unnecessary files/folders in repo:
    • .settings
    • build / target
    • .classpath, .project
  • .gitignore is properly configured
  • No compiled files (.class, .log, .tmp)
  • No IDE-specific files (IntelliJ, Eclipse, VSCode)

  • Follow standard Maven structure
  • Clear separation: controller / service / repository
  • No business logic inside controller
  • Packages are logically named

  • Project can run after clone without modification
  • README contains setup instructions
  • No hard-coded absolute paths
  • Environment variables are configurable

  • No sensitive data in source (password, API key)
  • Use application.properties or external config
  • Database config is not hardcoded

  • Meaningful variable and method names
  • No duplicated code
  • Methods are short and single-responsibility
  • Proper exception handling

  • Clear commit messages
  • No large unnecessary commits
  • Logical commit grouping
Mục tiêu

Rèn luyện kỹ năng quản lý mã nguồn trên Git Server.

Repository

Repo: <học viên điền link Git MyCRM>

Tag: v0.0.1 (không bắt buộc)

  • Không tồn tại file/thư mục dư thừa:
    • .settings
    • build / target
    • .classpath, .project
  • Cấu hình .gitignore đúng
  • Không commit file build (.class, .log)
  • Không commit file IDE

  • Tuân thủ chuẩn Maven
  • Phân tầng rõ ràng: controller / service / repository
  • Không viết business logic trong controller
  • Đặt tên package rõ ràng

  • Clone về chạy được ngay
  • Có README hướng dẫn
  • Không hardcode path
  • Cấu hình môi trường linh hoạt

  • Không để lộ password / API key
  • Dùng application.properties
  • Không hardcode DB config

  • Đặt tên biến rõ nghĩa
  • Không duplicate code
  • Method ngắn, rõ ràng
  • Xử lý exception hợp lý

  • Commit message rõ ràng
  • Không commit file lớn không cần thiết
  • Commit theo logic