mirror of
https://relay.ngit.dev/npub15qydau2hjma6ngxkl2cyar74wzyjshvl65za5k5rl69264ar2exs5cyejr/ngit-grasp.git
synced 2026-10-05 15:08:24 +00:00
DanConwayDev
ab43f7264a
- Update production-sync-testing.md to document issues as individual markdown files in work/active-issues/ instead of polluting the tracked how-to guide - Add issue template and workflow for creating, viewing, and resolving issues - Document active-issues/ purpose in work/README.md - Prevents accidental commits of transient testing issues - Makes issue management cleaner and more focused
97 lines
2.1 KiB
Markdown
97 lines
2.1 KiB
Markdown
# Work Directory
|
|
|
|
**Purpose:** Temporary working documents during development sessions
|
|
**Lifecycle:** Created during session → Archived at session end
|
|
**Status:** `.gitignore`d - not committed to version control
|
|
|
|
---
|
|
|
|
## What Goes Here
|
|
|
|
- Session summaries and notes
|
|
- Status reports and visual summaries
|
|
- Migration documentation (during migration)
|
|
- Planning documents
|
|
- Temporary analysis files
|
|
- **active-issues/**: Issues discovered during production sync testing (see [docs/how-to/production-sync-testing.md](../docs/how-to/production-sync-testing.md))
|
|
|
|
**Rule:** Nothing in this directory should be permanent. Archive or delete at session end.
|
|
|
|
---
|
|
|
|
## Workflow
|
|
|
|
### During Session
|
|
```bash
|
|
# Create working docs here
|
|
echo "Session notes..." > work/session-notes.md
|
|
echo "Status..." > work/status.md
|
|
```
|
|
|
|
### End of Session
|
|
```bash
|
|
# Archive important docs
|
|
mv work/session-notes.md docs/archive/2025-11-04-session-notes.md
|
|
|
|
# Delete obsolete docs
|
|
rm work/status.md
|
|
|
|
# Clean up
|
|
rm -rf work/*
|
|
```
|
|
|
|
---
|
|
|
|
## .gitignore
|
|
|
|
This directory is ignored by git (except this README):
|
|
|
|
```
|
|
work/*
|
|
!work/README.md
|
|
```
|
|
|
|
**Why:** Working documents are session-specific and shouldn't clutter the repository.
|
|
|
|
---
|
|
|
|
## Best Practices
|
|
|
|
**DO:**
|
|
- ✅ Use for temporary session work
|
|
- ✅ Use descriptive names
|
|
- ✅ Archive valuable content before deleting
|
|
- ✅ Clean up at session end
|
|
|
|
**DON'T:**
|
|
- ❌ Put permanent documentation here
|
|
- ❌ Reference work/ docs from permanent docs
|
|
- ❌ Commit work/ contents to git
|
|
- ❌ Let it accumulate files
|
|
|
|
---
|
|
|
|
## Alternative: Session-Specific Directories
|
|
|
|
For complex sessions, create dated subdirectories:
|
|
|
|
```bash
|
|
work/
|
|
├── 2025-11-04-diataxis-migration/
|
|
│ ├── notes.md
|
|
│ ├── checklist.md
|
|
│ └── visual-summary.txt
|
|
└── 2025-11-05-feature-x/
|
|
└── plan.md
|
|
```
|
|
|
|
Archive the entire directory when done:
|
|
```bash
|
|
tar czf docs/archive/2025-11-04-diataxis-migration.tar.gz work/2025-11-04-diataxis-migration/
|
|
rm -rf work/2025-11-04-diataxis-migration/
|
|
```
|
|
|
|
---
|
|
|
|
*This README is the only file in work/ committed to git.*
|