Skip to content

Commit 56b5bf6

Browse files
committed
docs(workflow): rename workspace context paths to tmp
1 parent 572e89b commit 56b5bf6

23 files changed

Lines changed: 113 additions & 113 deletions

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,4 +60,4 @@ htmlcov/
6060
.pytest_cache/
6161

6262
# Private/local documentation
63-
extras/
63+
tmp/

NEW_REPO_CHECKLIST.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,31 +24,31 @@ readlink .cursor/rules
2424

2525
## Setup workspace context files
2626

27-
- [ ] Create `extras/` (workspace-local, gitignored)
28-
- [ ] Create `extras/tasks.md` (minimum)
27+
- [ ] Create `tmp/` (workspace-local, gitignored)
28+
- [ ] Create `tmp/tasks.md` (minimum)
2929

3030
```bash
31-
mkdir -p extras
32-
cp .cursor/rules/templates/tasks.md.template extras/tasks.md
31+
mkdir -p tmp
32+
cp .cursor/rules/templates/tasks.md.template tmp/tasks.md
3333
```
3434

3535
Optional (for complex work):
3636

37-
- [ ] `extras/project-brief.md`
38-
- [ ] `extras/active-context.md`
39-
- [ ] `extras/progress.md`
37+
- [ ] `tmp/project-brief.md`
38+
- [ ] `tmp/active-context.md`
39+
- [ ] `tmp/progress.md`
4040

4141
```bash
42-
cp .cursor/rules/templates/project-brief.md.template extras/project-brief.md
43-
cp .cursor/rules/templates/active-context.md.template extras/active-context.md
44-
cp .cursor/rules/templates/progress.md.template extras/progress.md
42+
cp .cursor/rules/templates/project-brief.md.template tmp/project-brief.md
43+
cp .cursor/rules/templates/active-context.md.template tmp/active-context.md
44+
cp .cursor/rules/templates/progress.md.template tmp/progress.md
4545
```
4646

4747
## Git hygiene (recommended)
4848

49-
- [ ] Ensure `extras/` is ignored (add to your repo’s `.gitignore`):
49+
- [ ] Ensure `tmp/` is ignored (add to your repo’s `.gitignore`):
5050

5151
```gitignore
5252
# Private/local documentation
53-
extras/
53+
tmp/
5454
```

SETUP_GUIDE.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Setup Cursor rules + workspace context templates using symlinks or
55

66
# Setup Guide
77

8-
This repo is designed to be used across many projects via a **shared rules directory** (symlink/submodule). Workspace context files stay **workspace-local** under `extras/` (gitignored).
8+
This repo is designed to be used across many projects via a **shared rules directory** (symlink/submodule). Workspace context files stay **workspace-local** under `tmp/` (gitignored).
99

1010
## Recommended setup (team)
1111

@@ -50,9 +50,9 @@ Templates live at:
5050

5151
Workspace context files should live at:
5252

53-
- `extras/tasks.md`
54-
- `extras/active-context.md`
55-
- `extras/progress.md`
56-
- `extras/project-brief.md`
53+
- `tmp/tasks.md`
54+
- `tmp/active-context.md`
55+
- `tmp/progress.md`
56+
- `tmp/project-brief.md`
5757

5858
See `rules/050-workflow.mdc` for the workflow and file meanings.

commands/archive.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ Document the completed task, capture lessons learned, and update the knowledge b
3636
- Any gotchas or surprises?
3737

3838
4. **Update Context Files**
39-
- Update `extras/progress.md` with completion status
40-
- Create `extras/reflect-<task>.md` if significant learnings
41-
- Update `extras/tasks.md` to mark task complete
39+
- Update `tmp/progress.md` with completion status
40+
- Create `tmp/reflect-<task>.md` if significant learnings
41+
- Update `tmp/tasks.md` to mark task complete
4242

4343
5. **Identify Reusable Patterns**
4444
- Any patterns that should be standardized?
@@ -98,8 +98,8 @@ Document the completed task, capture lessons learned, and update the knowledge b
9898

9999
Save archives to:
100100

101-
- `extras/reflect-<task-name>.md` - For significant tasks
102-
- Or update `extras/progress.md` - For simpler summaries
101+
- `tmp/reflect-<task-name>.md` - For significant tasks
102+
- Or update `tmp/progress.md` - For simpler summaries
103103

104104
## Skip When
105105

commands/check-progress.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,12 +172,12 @@ Propose **one primary commit message** following `110-git.mdc` format:
172172

173173
## Phase 6: Task Management
174174

175-
1. Create or update `<repo-root>/extras/TODO.md` with:
175+
1. Create or update `<repo-root>/tmp/TODO.md` with:
176176
- Remaining tasks
177177
- Edge cases
178178
- Follow-ups and future improvements
179179

180-
2. Ensure `extras/` is present in `.gitignore`. Add it if missing.
180+
2. Ensure `tmp/` is present in `.gitignore`. Add it if missing.
181181

182182
## Constraints
183183

commands/code-commit.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -150,11 +150,11 @@ And ask:
150150
151151
---
152152
153-
## Step 6: Write commit message file under `extras/commit_messages`
153+
## Step 6: Write commit message file under `tmp/commit_messages`
154154
155155
Create the commit message file:
156156
157-
- Directory: `extras/commit_messages` (create if missing)
157+
- Directory: `tmp/commit_messages` (create if missing)
158158
- Filename format:
159159
- `YYYYMMDD_HHMMSS_<repo>_<branch>_<last7sha>.md`
160160
- Example: `20251228_154700_cursor-engineering-rules_main_abcd123.md`
@@ -164,7 +164,7 @@ Notes:
164164
- Use repo name from `basename "$(git rev-parse --show-toplevel)"`
165165
- Use branch name from `git branch --show-current`
166166
- Use last 7 of current HEAD via `git rev-parse --short=7 HEAD`
167-
- Ensure `extras/` is gitignored before writing artifacts
167+
- Ensure `tmp/` is gitignored before writing artifacts
168168
169169
> [!NOTE]
170170
> You cannot know the new commit hash until after committing. If desired, copy/rename the message file after commit to include the new commit short hash.
@@ -175,7 +175,7 @@ Notes:
175175
176176
Commit:
177177
178-
- `git commit -F extras/commit_messages/<filename>.md`
178+
- `git commit -F tmp/commit_messages/<filename>.md`
179179
180180
Confirm:
181181

commands/creative.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Required for:
3838
- Outline implementation approach
3939

4040
5. **Document Decision**
41-
- Create `creative-*.md` in extras/ folder
41+
- Create `creative-*.md` in tmp/ folder
4242
- Update `tasks.md` with design decisions
4343

4444
## Output Format

commands/init.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Initialize a new task by analyzing the project and determining the appropriate w
1616
- Scan project structure
1717
- Identify tech stack and patterns
1818
- Note existing conventions
19-
- Check for existing context files (`extras/prd.md`, `extras/design.md`, `extras/project-brief.md`, `extras/tasks.md`, `extras/active-context.md`)
19+
- Check for existing context files (`tmp/prd.md`, `tmp/design.md`, `tmp/project-brief.md`, `tmp/tasks.md`, `tmp/active-context.md`)
2020

2121
2. **Understand the Request**
2222
- What is the user asking for?
@@ -33,8 +33,8 @@ Initialize a new task by analyzing the project and determining the appropriate w
3333
| 4 | Complex | Architectural, cross-cutting, multi-day | `/plan` -> `/creative` -> `/qa` -> `/build` -> `/review` -> `/archive` |
3434

3535
4. **Set Up Context**
36-
- Create/update `extras/tasks.md` if needed
37-
- Create/update `extras/active-context.md` if needed
36+
- Create/update `tmp/tasks.md` if needed
37+
- Create/update `tmp/active-context.md` if needed
3838
- Note any existing progress
3939

4040
5. **Route to Next Command**

commands/kbcommit.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,11 +115,11 @@ LONG_DTTM="$(TZ=America/New_York date "+%A, %B %d, %Y @ %l:%M %p ET" | sed 's/
115115

116116
---
117117

118-
## Step 6: Write commit message file under `kb/extras/commit_messages`
118+
## Step 6: Write commit message file under `kb/tmp/commit_messages`
119119

120120
Create the commit message file:
121121

122-
- Directory: `extras/commit_messages`
122+
- Directory: `tmp/commit_messages`
123123
- Filename format:
124124
- `YYYYMMDD_HHMMSS_kb_<branch>_<last7sha>.md`
125125
- Example: `20251228_154700_kb_main_abcd123.md`
@@ -138,7 +138,7 @@ Commit using the file, and add the timestamp trailer:
138138
```bash
139139
set -euo pipefail
140140
LONG_DTTM="$(TZ=America/New_York date "+%A, %B %d, %Y @ %l:%M %p ET" | sed 's/ / /g')"
141-
git commit -F "extras/commit_messages/<filename>.md" --trailer "commit generated at ${LONG_DTTM}"
141+
git commit -F "tmp/commit_messages/<filename>.md" --trailer "commit generated at ${LONG_DTTM}"
142142
```
143143

144144
---

commands/self-review.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ Generate a structured review report:
164164

165165
**Generate Audit Report (per `020-agent-audit.mdc`):**
166166

167-
- Ensure `GIT_REPO_ROOT` is set, then write/append the report to `<GIT_REPO_ROOT>/extras/agent_reports/$(date +%F)-agent-report-<repo>-<branch>.md` (if `<GIT_REPO_ROOT>/extras/` exists and is gitignored) or `/tmp/$(date +%F)-agent-report-<repo>-<branch>.md`
167+
- Ensure `GIT_REPO_ROOT` is set, then write/append the report to `<GIT_REPO_ROOT>/tmp/agent_reports/$(date +%F)-agent-report-<repo>-<branch>.md` (if `<GIT_REPO_ROOT>/tmp/` exists and is gitignored) or `/tmp/$(date +%F)-agent-report-<repo>-<branch>.md`
168168
- Include:
169169
- Start/end timestamps (local and UTC)
170170
- Repo name, branch name, `HEAD` SHA

0 commit comments

Comments
 (0)