Prompt file imported from aghyara/GitHubCopilot_Customized (.github/prompts/explain-code.prompt.md). Copyright stays with the author.

Explain Code

Name: explain-code
Author: aghyara

Analyze the selected code and provide a clear, structured explanation:

Output Format

1. Purpose

One-sentence summary of what this code does and why it exists.

2. Walkthrough

Step-by-step explanation of the code flow:

Entry point and initialization
Key logic branches and data flow
Return values or side effects

3. Key Concepts

List any patterns, frameworks, or techniques used:

Express routing, middleware, Swagger
React hooks, context, routing
TypeScript generics, type guards, interfaces

4. Dependencies

Identify external dependencies and their roles:

npm packages used (express, axios, react-query, etc.)
Internal modules referenced (models, seedData, config)
Context providers (AuthContext, ThemeContext)

5. Architecture Fit

How this code fits into the OctoCAT Supply Chain architecture:

API routes serve REST endpoints mounted in index.ts
Models define entity interfaces used across API and frontend
Components compose the React UI with Tailwind styling
Reference the architecture doc for ERD relationships

6. Potential Issues

Flag any concerns:

Missing error handling or validation
Performance considerations
Security risks (hardcoded values, missing auth)
Missing Swagger documentation
Missing test coverage

7. Improvement Suggestions

Concise recommendations for enhancing the code quality.

{ "prompt": "# Explain Code\n\nAnalyze the selected code and provide a clear, structured explanation:\n\n## Output Format\n\n### 1. Purpose\nOne-sentence summary of what this code does and why it exists.\n\n### 2. Walkthrough\nStep-by-step explanation of the code flow:\n- Entry point and initialization\n- Key logic branches and data flow\n- Return values or side effects\n\n### 3. Key Concepts\nList any patterns, frameworks, or techniques used:\n- Express routing, middleware, Swagger\n- React hooks, context, routing\n- TypeScript generics, type guards, interfaces\n\n### 4. Dependencies\nIdentify external dependencies and their roles:\n- npm packages used (express, axios, react-query, etc.)\n- Internal modules referenced (models, seedData, config)\n- Context providers (AuthContext, ThemeContext)\n\n### 5. Architecture Fit\nHow this code fits into the OctoCAT Supply Chain architecture:\n- **API routes** serve REST endpoints mounted in `index.ts`\n- **Models** define entity interfaces used across API and frontend\n- **Components** compose the React UI with Tailwind styling\n- Reference the [architecture doc](../../docs/architecture.md) for ERD relationships\n\n### 6. Potential Issues\nFlag any concerns:\n- Missing error handling or validation\n- Performance considerations\n- Security risks (hardcoded values, missing auth)\n- Missing Swagger documentation\n- Missing test coverage\n\n### 7. Improvement Suggestions\nConcise recommendations for enhancing the code quality.", "variables": [], "notes": "Explain TypeScript/React code with architecture context, dependencies, and improvement suggestions", "metadata": { "source": { "provider": "github-prompts", "repository": "https://github.com/aghyara/GitHubCopilot_Customized", "path": ".github/prompts/explain-code.prompt.md", "ref": "594835c503236e49e8c4524cc16af7b5f4f55100", "url": "https://github.com/aghyara/GitHubCopilot_Customized/blob/594835c503236e49e8c4524cc16af7b5f4f55100/.github/prompts/explain-code.prompt.md", "key": "aghyara/GitHubCopilot_Customized/.github/prompts/explain-code.prompt.md" } } }

explain-code

About

Explain Code

Output Format

1. Purpose

2. Walkthrough

3. Key Concepts

4. Dependencies

5. Architecture Fit

6. Potential Issues

7. Improvement Suggestions

Use it

Manifest

Reviews