|
| 1 | +--- |
| 2 | +description: Work on a JIRA ticket by understanding the ticket description, overall feature design, and scope of work, then implementing the solution. |
| 3 | +--- |
| 4 | + |
| 5 | +### User Input |
| 6 | + |
| 7 | +```text |
| 8 | +$ARGUMENTS |
| 9 | +``` |
| 10 | + |
| 11 | +You **MUST** consider the user input before proceeding. If empty, ask the user for a ticket number to work on. |
| 12 | + |
| 13 | +## Goal |
| 14 | +Implement a JIRA ticket based on the overall design documentation and the specific scope defined in the ticket. |
| 15 | + |
| 16 | +## Steps |
| 17 | + |
| 18 | +### Step 1: Understand the Overall Design |
| 19 | +Locate and review the relevant design documentation: |
| 20 | +- Use search tools to find the corresponding design doc based on the JIRA ticket content |
| 21 | +- Read through the design doc thoroughly to understand the feature architecture |
| 22 | +- Describe your findings and understanding of the problem |
| 23 | +- Ask for confirmation before proceeding |
| 24 | + |
| 25 | +### Step 2: Create a New Branch |
| 26 | +Create a new stacked branch using `git stack create <branch-name>` for this work. |
| 27 | +- Make sure you add the JIRA ticket into the branch name |
| 28 | + |
| 29 | +### Step 3: Discuss Implementation Details |
| 30 | +Plan the implementation approach: |
| 31 | + |
| 32 | +**Important**: Focus on and limit the scope of work according to the JIRA ticket only. |
| 33 | + |
| 34 | +**Important**: Don't start from scratch - there should already be a design doc related to this ticket. Make sure you understand it first, then add implementation details if needed. |
| 35 | + |
| 36 | +Present your implementation plan and ask for confirmation. You may receive feedback on what to change - make sure you incorporate this feedback into your approach. |
| 37 | + |
| 38 | +### Step 4: Implement the Solution |
| 39 | +Write the implementation code: |
| 40 | +- Keep code clean and simple |
| 41 | +- Don't over-engineer or write unnecessary code |
| 42 | +- Follow existing code patterns and conventions in the codebase |
| 43 | + |
| 44 | +### Step 5: Write Tests |
| 45 | +Ensure adequate test coverage: |
| 46 | +- Write comprehensive tests for your implementation |
| 47 | +- Run build and tests to ensure they pass |
| 48 | +- Follow the testing guidelines in the CLAUDE.md file |
| 49 | + |
| 50 | +### Step 6: Update the Design Documentation |
| 51 | +After completing the code changes: |
| 52 | +- Review the related design doc and update it to reflect any discrepancies with the actual implementation |
| 53 | +- Document any important discussions or Q&As that occurred during implementation |
| 54 | +- Ensure documentation remains accurate and up-to-date |
| 55 | + |
| 56 | +### Step 7: Commit and Prepare PR |
| 57 | +Finalize your changes: |
| 58 | +- Commit the changes with a clear commit message |
| 59 | +- Prepare a comprehensive PR title and description following the PR template |
| 60 | +- Use `git stack push` to push changes and create the PR automatically |
| 61 | +- also please update the pr desc by following the pr desc guidline of the repo |
0 commit comments