mirror of
https://relay.ngit.dev/npub15qydau2hjma6ngxkl2cyar74wzyjshvl65za5k5rl69264ar2exs5cyejr/ngit-grasp.git
synced 2026-10-05 15:08:24 +00:00
docs: update README with final dcdev-issues structure
This commit is contained in:
@@ -0,0 +1,56 @@
|
||||
# dcdev-issues - User-Specific Issue Tracking
|
||||
|
||||
This is an orphan git branch for tracking issues across all worktrees in this repository.
|
||||
|
||||
## Structure
|
||||
|
||||
- **Branch**: `dcdev-issues` (orphan branch, no shared history with main)
|
||||
- **Worktree**: `worktrees/dcdev-issues/`
|
||||
- **Issues**: Markdown files at the top level of this worktree
|
||||
|
||||
## Access from Feature Worktrees
|
||||
|
||||
All feature worktrees have a symlink: `dcdev/issues/` → `../dcdev-issues/`
|
||||
|
||||
Example from a feature worktree:
|
||||
```bash
|
||||
cd worktrees/deletion-support
|
||||
ls dcdev/issues/ # List all issues
|
||||
cat dcdev/issues/foo.md # Read an issue
|
||||
```
|
||||
|
||||
## Creating or Updating Issues
|
||||
|
||||
1. Navigate to the issues worktree:
|
||||
```bash
|
||||
cd worktrees/dcdev-issues
|
||||
```
|
||||
|
||||
2. Create/edit issue file:
|
||||
```bash
|
||||
vim my-new-issue.md
|
||||
```
|
||||
|
||||
3. Commit the change:
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "issue: brief description"
|
||||
```
|
||||
|
||||
## Why This Setup?
|
||||
|
||||
- **User-specific**: `dcdev` namespace prevents conflicts with project files
|
||||
- **No .gitignore pollution**: Uses `.git/info/exclude` instead
|
||||
- **Portable**: Skills can set this up in any git repository
|
||||
- **Version controlled**: Full git history for issue tracking
|
||||
- **Shared across worktrees**: One source of truth for all issues
|
||||
|
||||
## Git Ignore Configuration
|
||||
|
||||
The `dcdev/` directory is ignored via `.git/info/exclude`:
|
||||
```bash
|
||||
# .git/info/exclude contains:
|
||||
dcdev
|
||||
```
|
||||
|
||||
This keeps the symlink out of version control without modifying the project's `.gitignore`.
|
||||
Reference in New Issue
Block a user