Skip to main content

TEMPLATE: Task Name Here

How to use this template
  1. Copy this file and rename it to your-task-name.md
  2. Fill in every section completely
  3. Commit the file before writing any code
  4. Link to this file in your Pull Request

Task: [Task Name]

Developer: [Your name] Date: [YYYY-MM-DD] Branch: feature/your-branch-name Status: In Progress / Completed / Blocked


Objective

What this task achieves and why it is needed. Be specific — what user problem does this solve?


Business Logic

The trading or domain logic this feature implements or touches.

  • List each business rule explicitly
  • Never assume — document only what you have confirmed
  • If you are unsure about any rule, mark it with [TO CONFIRM] and ask

Existing Flow

Which existing files, endpoints, and components are involved. Describe the current behaviour before your change.

User action

Frontend component (file: src/pages/...)

API call (file: src/services/api.js → method: ...)

Backend endpoint (file: backend/app/api/... → route: ...)

Database table: ...

Response back to UI

Files Allowed to Modify

List every file you are permitted to change for this task. Be explicit — unlisted files must not be touched.

FileChange
frontend/src/pages/Example.tsxAdd export button
frontend/src/services/api.jsAdd exportData() method
backend/app/api/example.pyAdd GET /export endpoint

Files NOT Allowed to Touch

FileReason
backend/nseeod/Live data pipeline — approval required
backend/app/database/session.pyCore DB session — approval required
frontend/src/App.tsxRouter — only touch if adding a new page

UI Flow

Step-by-step user journey through the UI for this feature.

  1. User navigates to [page]
  2. User clicks [button/action]
  3. UI shows [loading state]
  4. On success: [what user sees]
  5. On error: [what user sees]

API Flow

Request: [METHOD] /api/endpoint
Body: { field: value }

FastAPI route in: backend/app/api/file.py

Calls: [service/function]

DB query: SELECT/INSERT/UPDATE on [table]

Response: { success: true, data: [...] }

AI Prompt Used

Paste the exact prompt(s) given to Claude Code.

Session start command:

/tradeentry

Task prompt:

[Paste your exact Claude prompt here]

AI response summary: [Brief description of what Claude produced and any modifications made]


Risks

What could go wrong. What existing functionality could be affected.

  • Risk 1: [description] — Mitigation: [how you handle it]
  • Risk 2: [description] — Mitigation: [how you handle it]

Validation Checklist

Complete all items before submitting the PR.

  • No browser console errors
  • No API errors in Network tab
  • Existing features unaffected (smoke tested)
  • Edge cases handled: empty state, error state, loading state
  • npm run build passes in frontend/ (zero TypeScript errors)
  • npm run build passes in docs/ (if docs changed)
  • Feature tested end-to-end manually
  • Task markdown file committed
  • Relevant docs page updated
  • Version history updated if this is a major feature