429e92727b
## Description
- Introduced task-list.mdc for guidelines on creating and managing task
lists in Markdown format, detailing structure and maintenance practices.
- Added TASKS.md to .gitignore to prevent tracking of project-specific
task files.
Fixes #`Issue Number`
_or_
Fixes `Issue URL`
> [!WARNING]
> _If no issue exists, please create an issue first, and check with the
maintainers if the issue is valid._
## Automation
/ok-to-test tags=""
### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results -->
> [!CAUTION]
> If you modify the content in this section, you are likely to disrupt
the CI result for your PR.
<!-- end of auto-generated comment: Cypress test results -->
## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [ ] No
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
- **Documentation**
- Introduced a new guideline document outlining best practices for
creating and maintaining task lists in Markdown files, including
structure, maintenance, and AI usage instructions.
- **Chores**
- Updated the `.gitignore` file to exclude `TASKS.md` from version
control, ensuring project-specific task files are not tracked.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
100 lines
2.7 KiB
Plaintext
100 lines
2.7 KiB
Plaintext
# Task List Management
|
|
|
|
Guidelines for creating and managing task lists in Markdown files to track project progress
|
|
|
|
## Task List Creation
|
|
|
|
1. Create task lists in a markdown file (in the project root):
|
|
- Use `TASKS.md` or a descriptive name relevant to the feature (e.g., `ASSISTANT_CHAT.md`)
|
|
- Include a clear title and description of the feature being implemented
|
|
|
|
2. Structure the file with these sections:
|
|
```markdown
|
|
# Feature Name Implementation
|
|
|
|
Brief description of the feature and its purpose.
|
|
|
|
## Completed Tasks
|
|
|
|
- [x] Task 1 that has been completed
|
|
- [x] Task 2 that has been completed
|
|
|
|
## In Progress Tasks
|
|
|
|
- [ ] Task 3 currently being worked on
|
|
- [ ] Task 4 to be completed soon
|
|
|
|
## Future Tasks
|
|
|
|
- [ ] Task 5 planned for future implementation
|
|
- [ ] Task 6 planned for future implementation
|
|
|
|
## Implementation Plan
|
|
|
|
Detailed description of how the feature will be implemented.
|
|
|
|
### Relevant Files
|
|
|
|
- path/to/file1.ts - Description of purpose
|
|
- path/to/file2.ts - Description of purpose
|
|
```
|
|
|
|
## Task List Maintenance
|
|
|
|
1. Update the task list as you progress:
|
|
- Mark tasks as completed by changing `[ ]` to `[x]`
|
|
- Add new tasks as they are identified
|
|
- Move tasks between sections as appropriate
|
|
|
|
2. Keep "Relevant Files" section updated with:
|
|
- File paths that have been created or modified
|
|
- Brief descriptions of each file's purpose
|
|
- Status indicators (e.g., ✅) for completed components
|
|
|
|
3. Add implementation details:
|
|
- Architecture decisions
|
|
- Data flow descriptions
|
|
- Technical components needed
|
|
- Environment configuration
|
|
|
|
## AI Instructions
|
|
|
|
When working with task lists, the AI should:
|
|
|
|
1. Regularly update the task list file after implementing significant components
|
|
2. Mark completed tasks with [x] when finished
|
|
3. Add new tasks discovered during implementation
|
|
4. Maintain the "Relevant Files" section with accurate file paths and descriptions
|
|
5. Document implementation details, especially for complex features
|
|
6. When implementing tasks one by one, first check which task to implement next
|
|
7. After implementing a task, update the file to reflect progress
|
|
|
|
## Example Task Update
|
|
|
|
When updating a task from "In Progress" to "Completed":
|
|
|
|
```markdown
|
|
## In Progress Tasks
|
|
|
|
- [ ] Implement database schema
|
|
- [ ] Create API endpoints for data access
|
|
|
|
## Completed Tasks
|
|
|
|
- [x] Set up project structure
|
|
- [x] Configure environment variables
|
|
```
|
|
|
|
Should become:
|
|
|
|
```markdown
|
|
## In Progress Tasks
|
|
|
|
- [ ] Create API endpoints for data access
|
|
|
|
## Completed Tasks
|
|
|
|
- [x] Set up project structure
|
|
- [x] Configure environment variables
|
|
- [x] Implement database schema
|
|
``` |