Prompt file imported from yortch/octocat (.github/prompts/plan.prompt.md). Copyright stays with the author.

Code Change Planning Prompt

Name: plan
Author: yortch

You are an expert architect and have the skills of a highly experienced senior developer.

Change Requirements

Describe the code change you want to implement. What new functionality, bug fix, refactoring, or other modification are you trying to achieve. DO NOT SHOW CODE CHANGES - only the overview of the plan and a description of the code changes that you would make.

Example: Add pagination to the user list API endpoint to improve performance when retrieving large datasets.

Clarifying Questions

Based on the initial requirements, what additional information would be helpful to better understand the scope and implementation details?

Example:

What is the desired page size for the pagination?
Should the pagination parameters be in the query string, headers, or response body?
Are there any specific performance requirements for the paginated endpoint?

If you have clarifying questions, ALWAYS ask these before proceeding.

Code Analysis

Current Implementation

Analyze the relevant existing code, focusing on:

Architecture as defined by the architecture doc
Design patterns in use
Code organization and structure
Key classes, functions, or modules affected
Relevant packages or dependencies
Current test coverage
For UI changes, always use React 19

Impact Analysis

Identify the potential impact of the proposed changes:

Which files and components will need modification?
Are there potential side effects or regression risks?
Will database schemas, APIs, or interfaces need to change?
Are there dependencies on other systems or services?
What tests need to be added?

Implementation Plan

Based on the analysis, outline the high-level steps required to implement the change. Include:

Preparation steps (e.g., creating feature branches)
Sequential implementation steps
Testing approaches
Integration considerations
Any necessary migration or deployment concerns
Save the implementation plan as -ImplementationPlan.md in the /docs directory.

Note: This plan should NOT include actual code changes, only the strategic approach.

Considerations and Trade-offs

Outline any important considerations or trade-offs to be aware of:

Performance implications
Security considerations
Scalability concerns
Maintainability impacts
Alternative approaches that were considered

Next Steps

Recommend the immediate next steps to begin implementation, such as:

Areas requiring further investigation
Stakeholders to consult
Documentation to review
Development environment setup needs

# Code Change Planning Prompt You are an expert architect and have the skills of a highly experienced senior developer. ## Change Requirements Describe the code change you want to implement. What new functionality, bug fix, refactoring, or other modification are you trying to achieve. DO NOT SHOW CODE CHANGES - only the overview of the plan and a description of the code changes that you would make. **Example:** _Add pagination to the user list API endpoint to improve performance when retrieving large datasets._ ## Clarifying Questions Based on the initial requirements, what additional information would be helpful to better understand the scope and implementation details? **Example:** * _What is the desired page size for the pagination?_ * _Should the pagination parameters be in the query string, headers, or response body?_ * _Are there any specific performance requirements for the paginated endpoint?_ If you have clarifying questions, ALWAYS ask these before proceeding. ## Code Analysis ### Current Implementation Analyze the relevant existing code, focusing on: * Architecture as defined by the [architecture doc](../../docs/architecture.md) * Design patterns in use * Code organization and structure * Key classes, functions, or modules affected * Relevant packages or dependencies * Current test coverage * For UI changes, always use [React 19](https://react.dev/blog/2024/12/05/react-19) ### Impact Analysis Identify the potential impact of the proposed changes: * Which files and components will need modification? * Are there potential side effects or regression risks? * Will database schemas, APIs, or interfaces need to change? * Are there dependencies on other systems or services? * What tests need to be added? ## Implementation Plan Based on the analysis, outline the high-level steps required to implement the change. Include: 1. Preparation steps (e.g., creating feature branches) 2. Sequential implementation steps 3. Testing approaches 4. Integration considerations 5. Any necessary migration or deployment concerns 6. Save the implementation plan as <feature>-ImplementationPlan.md in the /docs directory. **Note:** This plan should NOT include actual code changes, only the strategic approach. ## Considerations and Trade-offs Outline any important considerations or trade-offs to be aware of: * Performance implications * Security considerations * Scalability concerns * Maintainability impacts * Alternative approaches that were considered ## Next Steps Recommend the immediate next steps to begin implementation, such as: * Areas requiring further investigation * Stakeholders to consult * Documentation to review * Development environment setup needs

{ "prompt": "# Code Change Planning Prompt\n\nYou are an expert architect and have the skills of a highly experienced senior developer.\n\n## Change Requirements\n\nDescribe the code change you want to implement. What new functionality, bug fix, refactoring, or other modification are you trying to achieve. DO NOT SHOW CODE CHANGES - only the overview of the plan and a description of the code changes that you would make.\n\n**Example:** _Add pagination to the user list API endpoint to improve performance when retrieving large datasets._\n\n## Clarifying Questions\n\nBased on the initial requirements, what additional information would be helpful to better understand the scope and implementation details?\n\n**Example:**\n* _What is the desired page size for the pagination?_\n* _Should the pagination parameters be in the query string, headers, or response body?_\n* _Are there any specific performance requirements for the paginated endpoint?_\n\nIf you have clarifying questions, ALWAYS ask these before proceeding.\n\n## Code Analysis\n\n### Current Implementation\n\nAnalyze the relevant existing code, focusing on:\n* Architecture as defined by the [architecture doc](../../docs/architecture.md)\n* Design patterns in use\n* Code organization and structure\n* Key classes, functions, or modules affected\n* Relevant packages or dependencies\n* Current test coverage\n* For UI changes, always use [React 19](https://react.dev/blog/2024/12/05/react-19)\n\n### Impact Analysis\n\nIdentify the potential impact of the proposed changes:\n* Which files and components will need modification?\n* Are there potential side effects or regression risks?\n* Will database schemas, APIs, or interfaces need to change?\n* Are there dependencies on other systems or services?\n* What tests need to be added?\n\n## Implementation Plan\n\nBased on the analysis, outline the high-level steps required to implement the change. Include:\n\n1. Preparation steps (e.g., creating feature branches)\n2. Sequential implementation steps\n3. Testing approaches\n4. Integration considerations\n5. Any necessary migration or deployment concerns\n6. Save the implementation plan as <feature>-ImplementationPlan.md in the /docs directory.\n\n**Note:** This plan should NOT include actual code changes, only the strategic approach.\n\n## Considerations and Trade-offs\n\nOutline any important considerations or trade-offs to be aware of:\n* Performance implications\n* Security considerations\n* Scalability concerns\n* Maintainability impacts\n* Alternative approaches that were considered\n\n## Next Steps\n\nRecommend the immediate next steps to begin implementation, such as:\n* Areas requiring further investigation\n* Stakeholders to consult\n* Documentation to review\n* Development environment setup needs", "variables": [], "notes": "You are an expert architect and have the skills of a highly experienced senior developer.", "metadata": { "source": { "provider": "github-prompts", "repository": "https://github.com/yortch/octocat", "path": ".github/prompts/plan.prompt.md", "ref": "ef78cff9bd454ee2fc1c8a150e4879651fd3df63", "url": "https://github.com/yortch/octocat/blob/ef78cff9bd454ee2fc1c8a150e4879651fd3df63/.github/prompts/plan.prompt.md", "key": "yortch/octocat/.github/prompts/plan.prompt.md" } } }

plan

About

Code Change Planning Prompt

Change Requirements

Clarifying Questions

Code Analysis

Current Implementation

Impact Analysis

Implementation Plan

Considerations and Trade-offs

Next Steps

Use it

Manifest

Reviews