2025-03-21 14:06:36 -04:00
|
|
|
---
|
|
|
|
description: Guidelines for continuously improving Cursor rules based on emerging code patterns and best practices.
|
|
|
|
globs: **/*
|
|
|
|
alwaysApply: true
|
|
|
|
---
|
|
|
|
|
|
|
|
- **Rule Improvement Triggers:**
|
|
|
|
- New code patterns not covered by existing rules
|
|
|
|
- Repeated similar implementations across files
|
|
|
|
- Common error patterns that could be prevented
|
|
|
|
- New libraries or tools being used consistently
|
|
|
|
- Emerging best practices in the codebase
|
|
|
|
|
|
|
|
- **Analysis Process:**
|
|
|
|
- Compare new code with existing rules
|
|
|
|
- Identify patterns that should be standardized
|
|
|
|
- Look for references to external documentation
|
|
|
|
- Check for consistent error handling patterns
|
|
|
|
- Monitor test patterns and coverage
|
|
|
|
|
|
|
|
- **Rule Updates:**
|
|
|
|
- **Add New Rules When:**
|
|
|
|
- A new technology/pattern is used in 3+ files
|
|
|
|
- Common bugs could be prevented by a rule
|
|
|
|
- Code reviews repeatedly mention the same feedback
|
|
|
|
- New security or performance patterns emerge
|
|
|
|
|
|
|
|
- **Modify Existing Rules When:**
|
|
|
|
- Better examples exist in the codebase
|
|
|
|
- Additional edge cases are discovered
|
|
|
|
- Related rules have been updated
|
|
|
|
- Implementation details have changed
|
|
|
|
|
|
|
|
- **Example Pattern Recognition:**
|
|
|
|
```typescript
|
|
|
|
// If you see repeated patterns like:
|
|
|
|
const data = await prisma.user.findMany({
|
|
|
|
select: { id: true, email: true },
|
|
|
|
where: { status: 'ACTIVE' }
|
|
|
|
});
|
|
|
|
|
|
|
|
// Consider adding to [prisma.mdc](mdc:.cursor/rules/prisma.mdc):
|
|
|
|
// - Standard select fields
|
|
|
|
// - Common where conditions
|
|
|
|
// - Performance optimization patterns
|
|
|
|
```
|
|
|
|
|
|
|
|
- **Rule Quality Checks:**
|
|
|
|
- Rules should be actionable and specific
|
|
|
|
- Examples should come from actual code
|
|
|
|
- References should be up to date
|
|
|
|
- Patterns should be consistently enforced
|
|
|
|
|
|
|
|
- **Continuous Improvement:**
|
|
|
|
- Monitor code review comments
|
|
|
|
- Track common development questions
|
|
|
|
- Update rules after major refactors
|
|
|
|
- Add links to relevant documentation
|
|
|
|
- Cross-reference related rules
|
|
|
|
|
|
|
|
- **Rule Deprecation:**
|
|
|
|
- Mark outdated patterns as deprecated
|
|
|
|
- Remove rules that no longer apply
|
|
|
|
- Update references to deprecated rules
|
|
|
|
- Document migration paths for old patterns
|
|
|
|
|
|
|
|
- **Documentation Updates:**
|
|
|
|
- Keep examples synchronized with code
|
|
|
|
- Update references to external docs
|
|
|
|
- Maintain links between related rules
|
|
|
|
- Document breaking changes
|
docs: Update documentation for new AI/config architecture and finalize cleanup
This commit updates all relevant documentation (READMEs, docs/*, .cursor/rules) to accurately reflect the finalized unified AI service architecture and the new configuration system (.taskmasterconfig + .env/mcp.json). It also includes the final code cleanup steps related to the refactoring.
Key Changes:
1. **Documentation Updates:**
* Revised `README.md`, `README-task-master.md`, `assets/scripts_README.md`, `docs/configuration.md`, and `docs/tutorial.md` to explain the new configuration split (.taskmasterconfig vs .env/mcp.json).
* Updated MCP configuration examples in READMEs and tutorials to only include API keys in the `env` block.
* Added/updated examples for using the `--research` flag in `docs/command-reference.md`, `docs/examples.md`, and `docs/tutorial.md`.
* Updated `.cursor/rules/ai_services.mdc`, `.cursor/rules/architecture.mdc`, `.cursor/rules/dev_workflow.mdc`, `.cursor/rules/mcp.mdc`, `.cursor/rules/taskmaster.mdc`, `.cursor/rules/utilities.mdc`, and `.cursor/rules/new_features.mdc` to align with the new architecture, removing references to old patterns/files.
* Removed internal rule links from user-facing rules (`taskmaster.mdc`, `dev_workflow.mdc`, `self_improve.mdc`).
* Deleted outdated example file `docs/ai-client-utils-example.md`.
2. **Final Code Refactor & Cleanup:**
* Corrected `update-task-by-id.js` by removing the last import from the old `ai-services.js`.
* Refactored `update-subtask-by-id.js` to correctly use the unified service and logger patterns.
* Removed the obsolete export block from `mcp-server/src/core/task-master-core.js`.
* Corrected logger implementation in `update-tasks.js` for CLI context.
* Updated API key mapping in `config-manager.js` and `ai-services-unified.js`.
3. **Configuration Files:**
* Updated API keys in `.cursor/mcp.json`, replacing `GROK_API_KEY` with `XAI_API_KEY`.
* Updated `.env.example` with current API key names.
* Added `azureOpenaiBaseUrl` to `.taskmasterconfig` example.
4. **Task Management:**
* Marked documentation subtask 61.10 as 'done'.
* Includes various other task content/status updates from the diff summary.
5. **Changeset:**
* Added `.changeset/cuddly-zebras-matter.md` for user-facing `expand`/`expand-all` improvements.
This commit concludes the major architectural refactoring (Task 61) and ensures the documentation accurately reflects the current system.
2025-04-25 14:43:12 -04:00
|
|
|
Follow [cursor_rules.mdc](mdc:.cursor/rules/cursor_rules.mdc) for proper rule formatting and structure.
|