Skip to content

Commit 55cab60

Browse files
authored
docs: clarify template initialization scope and prevent TaskMaster auto-setup (#8)
* feat: improve template workflow and README handling - Clarify GitHub template vs clone workflows in README and rules - Abstract README template to .cursor/templates/project_readme.md - Rename preserved README to how_to_use_this_template.md - Minimize workflow rules by extracting template content - Better organization and maintainability * refactor: simplify and improve template workflow - Remove unnecessary .gitignore creation step (already exists in template) - Simplify paging prevention to single export PAGER="" command - Update prompt format to "initialize this project as <my project name>" - Streamline workflow rules and remove verbose CLI instructions - More natural and consistent user experience * refactor: abstract detailed workflow steps to separate files - Create repository_initialization.mdc with detailed git setup steps - Create template_setup.mdc with detailed project initialization steps - Update workflow.mdc to reference abstracted files instead of inline content - Emphasize mandatory Pull Request step in Branch Protection Workflow - Reduce context usage while maintaining access to detailed instructions * docs: clarify template initialization scope and prevent TaskMaster auto-setup - Add explicit boundaries for template initialization workflow - Create 'What NOT to Include' section to prevent scope creep - Emphasize that TaskMaster, PRD creation, and git setup are separate workflows - Remove automatic TaskMaster setup from template initialization - Add warning in main workflow.mdc about initialization scope
1 parent 49c14c5 commit 55cab60

2 files changed

Lines changed: 14 additions & 3 deletions

File tree

.cursor/rules/template_setup.mdc

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,27 @@ alwaysApply: false
66
# Template Setup Workflow
77

88
## Agent-Driven Initialization
9-
When a user prompts "initialize this project as <my project name>", I will automatically handle template setup:
9+
When a user prompts "initialize this project as <my project name>", I will **ONLY** handle template setup (do NOT include TaskMaster or PRD work):
1010

1111
1. **Copy `.cursor/.mcp.json.example` to `.cursor/mcp.json`** and prompt user for their API keys
12-
2. **Optionally copy `.env.example` to `.env`** only if they plan to use TaskMaster CLI (not needed for MCP workflow)
13-
3. **Remove template-specific content** and customize for their project:
12+
2. **Remove template-specific content** and customize for their project:
1413
- **Move `README.md` to `docs/how_to_use_this_template.md`** to preserve template documentation
1514
- **Copy `.cursor/templates/project_readme.md` to the project root as `README.md`** to create the new project-specific README
1615
- **Update the new `README.md`** by replacing `[Project Name]` placeholder with user-provided name or "My Project"
1716
- Update `SECURITY.md` to remove template references
1817
- Remove or update any hardcoded paths in configuration files
1918

19+
## What NOT to Include in Template Initialization
20+
- **Do NOT set up TaskMaster** - This is a separate workflow that requires explicit user request
21+
- **Do NOT create PRDs** - Project Requirements Documents are separate from template setup
22+
- **Do NOT copy `.env.example` to `.env`** - Only do this if user specifically requests TaskMaster CLI setup
23+
- **Do NOT initialize git repository** - Template initialization is separate from git setup
24+
- **Do NOT create tasks or project management files** - Focus only on template structure
25+
2026
## Environment File Distinction
2127
- **Template `.env.example`**: Contains TaskMaster CLI configuration (ANTHROPIC_API_KEY, PERPLEXITY_API_KEY, etc.)
2228
- **Project `.env`**: Will contain application-specific configuration (database URLs, app API keys, etc.)
2329
- **Never mix these**: TaskMaster configuration is separate from project application configuration
30+
31+
## After Template Initialization
32+
Template initialization is complete after customizing the project files. TaskMaster, PRD creation, and git setup are separate workflows that require explicit user requests.

.cursor/rules/workflow.mdc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ alwaysApply: true
77
## Template Setup Workflow
88
For detailed steps on template setup when initializing a project, see [template_setup.mdc](mdc:.cursor/rules/template_setup.mdc).
99

10+
**IMPORTANT**: Template initialization is ONLY about setting up project structure and configuration. TaskMaster, PRD creation, and git setup are separate workflows that require explicit user requests.
11+
1012
## MCP Server Workflows
1113

1214
### Memory MCP

0 commit comments

Comments
 (0)