hackforla
Dev: Add recommended extensions to .vscode
UPDATE LABELS: Add the following labels to each new issue, and remove default labels. Then remove this section:
- Complexity
- Feature
- Role
- Milestone
- Size
- Project
Select Project Board (located in the right sidebar)- Then remove this section:
- Under Type,
- P: HUU: Project Board
Select the applicable type (located in the right sidebar). Then remove this section:
- Under Type,
- Bug - select if the issue is to fix a bug
- Feature - select if the issue is product feature
- Task - select if the issue is administrative, not a feature
Select issue "Planned Start and End date". Then remove this section:
- Under selected Project Board: P: HUU: Project Board Under Type,
🧩 Overview
This issue is for tracking engineering work related to #[add related user story issue number], which is [Provide a brief description of the feature, outlining its purpose and expected outcome see the related user story - We need to do X for Y reason.]
More Info
Brief summary of the feature or enhancement, tied to the product spec.
Example: Implement the frontend and backend logic for the Host Intake Profile form based on the approved product story.
📐 Scope of Work
Clearly define what’s in scope for this issue.
- Create form fields dynamically from schema
- Implement save progress functionality (autosave and manual)
- Add validation rules as defined in the schema
- Ensure user authentication is respected
- Set up database schema if not yet implemented
🔧 Engineering Tasks
These are the specific technical work items required to build and deliver a new feature. They break down the overall feature into concrete, actionable development work.
Steps to Implement: These are sample tasks - adapt and expand based on the specific feature requirements Break down the feature into specific engineering tasks
- [Add engineering action items here] Such as:
- [ ] Implement backend logic for profile update
- [ ] Add UI form fields (email, display name)
- [ ] Connect frontend to backend endpoint
- [ ] Add input validation on frontend
- [ ] Write unit and integration tests
- [ ] Deploy under feature flag
- [ ] Update API docs if applicable
✅ Acceptance Criteria
*Takes the design acceptance criteria and defines the technical requirements needed to make those user-facing features actually work - "What technical work must be completed to deliver this user experience".
- [ ] xxx
- [ ] xxx
- [ ] xxx
- [ ] xxx
🔄 Dependencies
- Select "dependency" label and move this section to the top of the page. Describe the dependency or link to the issue that is blocking this one from proceeding.
📦 Technical Notes
Provides the engineering team with technical context and constraints that help us make good implementation decisions and avoid common pitfalls specific to our system. Engineering team should document their approach here, such as:
- Component hierarchy or file structure plan
- Libraries or dependencies needed
- How local state and API responses will be managed
- Planned test coverage
- API endpoint details
- Feature flag configuration
- Known limitations or constraints
🧪 Testing Strategy
Defines the comprehensive approach for validating that the feature works correctly, performs well, and meets all requirements before release. "How will we validate this feature works correctly before shipping it?"
- Unit tests for form logic and validation
- Integration test with backend service
- Cross-browser UI check
- Responsive layout testing (mobile, tablet, desktop)
- Manual testing for edge cases and user workflows
🚩 Risks / Considerations
Identifies potential technical, implementation, and delivery challenges that could impact the successful completion of the feature. "What could go wrong technically, and how should we prepare for it?"
Examples:
- "Risk: File upload feature could impact server performance - plan load testing and optimization"
- "Consideration: New authentication flow requires coordination with DevOps for environment variables"
- "Risk: API spec not finalized – may need adjustments during development"
- "Consideration: Edge case for conditional fields requires backend logic coordination"
- "Dependency: DB schema must be deployed before feature implementation" Feature-specific risks:
- [ ] [Risk/consideration]: [Impact and mitigation approach]
- [ ] [Risk/consideration]: [Impact and mitigation approach]
🧵 Related Issues
- Product Issue: [Link]
- Design QA (if created): [Link]
- Backend Ticket (if split): [Link]
- Frontend Ticket (if split): [Link]
Action Items
- Assign and Prep
- [ ] Engineer: Understand the Issue to be drafted and Self-Assign
- [ ] Engineer: Conduct the necessary research (if applicable), clarify any questions
- [ ] Engineer: Engineer work with Engineer team Lead to assign the appropriate size & complexity:
- [ ] Engineer/Engineering Lead: determine if work should be split into multiple issues, if so create those issues and link them in this issue (if applicable) or create as standalone.
- [ ] Engineer/Engineering Lead: determine and provide "start and end date" for Product to update.
- Draft and Review:
- [ ] Engineer: Change Issue Status to "For Review/Feedback Needed"
- [ ] Engineer: Add Label "Ready for: Dev Peer Review"
- [ ] Engineer 1st Level/Peer Review: Review and compare against Acceptance Criteria, provide feedback in comment section below, tag assignee.
- [ ] Engineer 1st Level/Peer Reviewer: Change Issue Status to "Questions/Clarification" and add label "Ready for Dev Team Member"
- [ ] Engineer (Assignee): Change Issue Status to "In Progress"
- [ ] Engineer (Assignee): Review issue comment(s) and resolve accordingly
- [ ] Repeat above steps until all Acceptance Criteria are accounted and comments are resolved
- [ ] Engineer 1st Level/Peer Reviewer: Change Issue Status to "For Review/Feedback Needed" and add label "Ready for: Dev Lead"
- [ ] 2nd final/Lead Engineer: Review and compare against Acceptance Criteria, provide feedback (if any) in comment section below, add label "Ready for Dev Team Member"
- [ ] Repeat above steps until all Acceptance Criteria are accounted and comments are resolved
📎 Resources
- Figma UI Reference: [Link]
- Technical Design Doc (if applicable): [Link]
Attachments/Screenshots (If Applicable):
- (Insert wireframes, UI mockups, or relevant references)
Overview
Add a .vscode folder to the root of the repository to provide some suggested extensions that work with our codebase.
Current list of recommendations:
- ESLint - Integrates ESLint into editor
- Prettier - Code formatting for app
- Pretty Typescript Errors - Makes for more readable Typescript errors
- SQLite - Explore and query SQLite databases
Others to consider:
- Flask8 - code formatting for Python
Action
- [ ] Update issue with the current Dev issue template format
labels updated and added to MVP -- note this does not pertain to application source code changes, nor infrastructure/testing/etc, it is a requirement for developer and admin experience (e.g. to avoid large diffs due to pre-configured style preferences in contributors' editors)
