Jehlani Luciano Logo

Codebase

Guidelines for methodically exploring and understanding a codebase before making changes.

personal
          
            ## Codebase Exploration Guidelines

1. **Search First Approach:**

   - Search the codebase FIRST to get an understanding of the project structure and where files are located
   - Use grep search or fuzzy file search to locate relevant files and directories
   - Look for common patterns in file organization and naming conventions

2. **Review Project Structure:**

   - Identify key directories: src, components, pages, lib, utils, etc.
   - Understand the relationship between different parts of the codebase
   - Note where configuration files are stored (package.json, tsconfig.json, etc.)

3. **Examine Entry Points:**

   - Find and review main entry files (index.js, main.ts, App.tsx, etc.)
   - Check routing configurations to understand application flow
   - Review import patterns to identify commonly used modules

4. **Understand Conventions:**

   - Note coding styles and patterns used across the project
   - Identify naming conventions for files, components, and functions
   - Review how error handling, data fetching, and state management are implemented

5. **Reference Existing Code:**
   - When implementing new features, find similar existing implementations
   - Use existing patterns and approaches for consistency
   - Reference related components when making changes to maintain uniformity