Skip to content

Commit

Permalink
feat(planning): update templates
Browse files Browse the repository at this point in the history
  • Loading branch information
marespopa committed Mar 18, 2024
1 parent 5e36d5e commit 37b2e03
Show file tree
Hide file tree
Showing 5 changed files with 135 additions and 125 deletions.
4 changes: 2 additions & 2 deletions client/components/overview/OverviewSection.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -48,12 +48,12 @@ const OverviewSection = ({ handleReset }: Props) => {
{
id: 1,
name: 'details',
label: 'Details',
label: 'Preview',
},
{
id: 2,
name: 'edit',
label: 'Edit',
label: 'Markdown',
},
{
id: 3,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ import ButtonSecondary from '@/components/forms/buttons/ButtonSecondary'
import { useAtom } from 'jotai'
import { atom_description, atom_title } from 'jotai/atoms'
import React from 'react'
import { DEFAULT_TEMPLATES } from './contants'
import { DEFAULT_TEMPLATES } from './templates'

type TemplateVariant = 'feature' | 'bug' | 'code_review' | 'generic'
type TemplateVariant = 'feature' | 'bug' | 'code_review' | 'daily' | 'generic'

type Template = {
id: number
Expand All @@ -25,22 +25,27 @@ const TemplateSection = () => {
{
id: 0,
name: 'generic',
label: 'Generic Task',
label: 'Generic',
},
{
id: 1,
name: 'feature',
label: 'Feature Implementation',
label: 'Feature',
},
{
id: 2,
name: 'bug',
label: 'Bug Fix',
label: 'Bug',
},
{
id: 3,
name: 'daily',
label: 'Daily Standup',
},
{
id: 4,
name: 'code_review',
label: 'Code Review Checklist ',
label: 'Code Review ',
},
]

Expand Down
116 changes: 0 additions & 116 deletions client/components/planning/TemplateSection/contants.ts

This file was deleted.

121 changes: 121 additions & 0 deletions client/components/planning/TemplateSection/templates.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
export const DEFAULT_TEMPLATES = {
feature: {
title: '✨ Feature: [Feature Name]',
description: `## πŸ“– Overview
A concise description of what this feature is and its expected impact. Mention the key user benefit or problem it solves.
### 🎯 Goals
- Main goal of the feature.
- Secondary goals or benefits, if any.
## πŸ“‹ Requirements
Briefly list the core requirements or conditions this feature must meet. Detailed requirements can be managed as subtasks.
## πŸ”— Links
- **Project Tracking:** [Link_to_project_management_tool_or_ticket](#)
- **Related Documents:** [Link_to_related_documents_or_resources](#)
- **Design Resources:** [Link_to_design_resources_or_assets](#)
- **API Documentation:** [Link_to_API_documentation](#)
- **Other Relevant Links:** [Miscellaneous_links](#)
## πŸ›  Development Steps
Outline the major steps or phases in development. Use subtasks to manage detailed tasks and changes.
1. [General step 1]
2. [General step 2]
3. [Add more as needed]
## πŸ§ͺ Testing Strategy
- **πŸ” Unit Tests:** Key areas to cover.
- **βš™οΈ Integration Tests:** Important interactions with other features or services.
- **πŸ‘₯ User Acceptance Testing (UAT):** Criteria for UAT and key user scenarios.
## πŸ”— Dependencies
List any internal or external dependencies that could affect this feature's development timeline.
## ⏳ Time Estimate
Provide a rough estimate for scheduling purposes. Update as the feature progresses.
## πŸ“ Notes
Include any additional notes, open questions, or considerations here. This section can be updated as the feature development evolves.`,
},
bug: {
title: '🐞 Bug Fix: [Bug Title] ',
description: `## 🚨 Overview
Briefly describe the issue.
## πŸ“ Occurrence
Specify the part(s) of the app affected.
## πŸ•΅οΈ Steps to Reproduce
1. First step
2. Second step
- **Frequency:** Always? Sometimes?
## 🎯 Expected vs. Actual
- **Expected:** What should happen?
- **Actual:** What actually happens?
## πŸ“Έ Attachments
- **Screenshots/Videos:** [Link or attach]
- **Logs:** [Link or attach]
## πŸ›  Suggested Fix (If any)
- **Your thoughts:** Brief idea on fixing it (optional).
## πŸ”— Useful Links
- [Related_Docs](#)
- [Similar_Issues](#)`,
},
daily: {
title: 'πŸŒ… Daily Stand-up Update',
description: `## βœ… Yesterday's Achievements
- Completed task 1
- Reviewed PR from colleague
## 🎯 Today's Goals
- Start working on feature X
- Fix bug reported by QA
## ❌ Blockers
- Awaiting design assets for feature Y
- Need clarification on API endpoint
## πŸ”— Links
- [Yesterday's_PR](#)
- [Bug_Report](#)`,
},
code_review: {
title: 'πŸ” Code Review: [Feature/Bugfix Name]',
description: `## πŸ›  Functionality
- [ ] Does the code accomplish the task’s objective?
## πŸ“ Best Practices
- [ ] Is the code clean and following best practices?
## πŸš€ Performance
- [ ] Any potential performance impacts?
## πŸ§ͺ Testing
- [ ] Is the task adequately tested?`,
},
generic: {
title: 'πŸ“Œ Task Title',
description: `## πŸ“– Overview
A brief description of what this task entails and its purpose.
## 🎯 Objective
Clearly state what success looks like for this task.
## ⏱ Estimated Time
Rough estimate to complete.
## πŸ“Œ Steps to Completion
List the key steps in order, if applicable.
## πŸ”— Resources
- [Documentation](#)
- [Design_Mockups](#)
- [Relevant_Tickets](#)`,
},
}
2 changes: 1 addition & 1 deletion client/jotai/atoms.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { atomWithStorage } from 'jotai/utils'
import { type Task } from '../types/types'
import { DEFAULT_TEMPLATES } from '@/components/planning/TemplateSection/contants'
import { DEFAULT_TEMPLATES } from '@/components/planning/TemplateSection/templates'

export type Snippet = {
id: string
Expand Down

0 comments on commit 37b2e03

Please sign in to comment.