Files
english/.opencode/skills/ck-plan/references/codebase-understanding.md
2026-04-12 01:06:31 +07:00

1.9 KiB

Codebase Understanding Phase

When to skip: If provided with scout reports, skip this phase.

Core Activities

Parallel Scout Agents

  • Use /ck:scout ext (preferred) or /ck:scout (fallback) skill invocation to search the codebase for files needed to complete the task
  • Each scout locates files needed for specific task aspects
  • Wait for all scout agents to report back before analysis
  • Efficient for finding relevant code across large codebases

Essential Documentation Review

ALWAYS read these files first:

  1. ./docs/development-rules.md (IMPORTANT)

    • File Name Conventions
    • File Size Management
    • Development rules and best practices
    • Code quality standards
    • Security guidelines
  2. ./docs/codebase-summary.md

    • Project structure and current status
    • High-level architecture overview
    • Component relationships
  3. ./docs/code-standards.md

    • Coding conventions and standards
    • Language-specific patterns
    • Naming conventions
  4. ./docs/design-guidelines.md (if exists)

    • Design system guidelines
    • Branding and UI/UX conventions
    • Component library usage

Environment Analysis

  • Review development environment setup
  • Analyze dotenv files and configuration
  • Identify required dependencies
  • Understand build and deployment processes

Pattern Recognition

  • Study existing patterns in codebase
  • Identify conventions and architectural decisions
  • Note consistency in implementation approaches
  • Understand error handling patterns

Integration Planning

  • Identify how new features integrate with existing architecture
  • Map dependencies between components
  • Understand data flow and state management
  • Consider backward compatibility

Best Practices

  • Start with documentation before diving into code
  • Use scouts for targeted file discovery
  • Document patterns found for consistency
  • Note any inconsistencies or technical debt
  • Consider impact on existing features