@@ -25,7 +25,7 @@ applyTo: '**/*.md'
2525- ** Phase planning** (` docs/WORKDIR/phases/PHASEXX_*.md ` ): Update ` [x] ` checklist at session end
2626- ** Technical discoveries** : Place in ` docs/WORKDIR/support/ ` (e.g., ` CRITICAL_VFS_DISCOVERY.md ` )
2727- ** Lessons learned** (` docs/WORKDIR/lessons/LESSONS_LEARNED.md ` ): Key takeaways from phases and work cycles
28- - ** Known Issues** : Place in ` docs/KNOWN_ISSUES/ ` with format ` ISSUE-XXX_description.md ` (e.g., ` ISSUE-001_shell_map_unit_immortality.md ` )
28+ - ** Known Issues** : Track in [ GitHub Issues ] ( https://github.com/fbraz3/GeneralsX/issues/ ) — do NOT create new markdown issue files
2929
3030## Documentation Organization
3131
@@ -110,45 +110,59 @@ applyTo: '**/*.md'
110110
111111** Not here** : Session reports, summaries, analysis, phase progress
112112
113- ### ` docs/KNOWN_ISSUES/ ` - Issue Tracking
114- ** Purpose** : Documented known issues, bugs, limitations, and pending investigations
115- ** Structure** : One issue per file
116- ** Naming Convention** : ` ISSUE-XXX_slug_description.md `
117- - ` XXX ` = Zero-padded issue number (001, 002, 003, etc.)
118- - ` slug_description ` = Brief lowercase, underscore-separated description
119-
120- ** Examples** :
121- - ` ISSUE-001_shell_map_unit_immortality.md `
122- - ` ISSUE-002_audio_crackling_on_startup.md `
123- - ` ISSUE-003_replay_desync_multiplayer.md `
124-
125- ** Status Values** :
126- - OPEN — Confirmed issue, awaiting investigation or fix
127- - INVESTIGATING — Currently being researched; uncertain root cause
128- - BLOCKED — Waiting for external feedback, data access, or prerequisites
129- - RESOLVED — Fixed; waiting for verification or release
130- - WONTFIX — Intentionally deferred; rationale documented
131-
132- ** Severity Levels** :
133- - Critical — Game-breaking, prevents progress
134- - High — Major feature impaired, significant gameplay impact
135- - Medium — Observable but workaroundable, cosmetic impact
136- - Low — Cosmetic only, no gameplay impact
137-
138- ** Component Categories** :
139- - Graphics, Audio, Gameplay, Platform, Build, Other
140-
141- ** Structure** :
142- - Status, Session Discovered, Severity, Component, Reproducibility (header)
143- - Symptom (observable behavior)
144- - Investigation Summary (root cause analysis, hypotheses)
145- - Code Audit Results (what was checked)
146- - Next Steps (actionable items for future investigation)
147- - Workaround (if available)
148- - Impact (gameplay, stability, determinism, release blocker)
149- - Reference (links to code, dev diary, etc.)
150-
151- See ` docs/KNOWN_ISSUES/README.md ` for detailed template and guidelines.
113+ ## Issue Tracking — GitHub is the Source of Truth
114+
115+ ** CRITICAL POLICY** : All issues, bugs, feature requests, and enhancements MUST be tracked in ** GitHub Issues** (` https://github.com/fbraz3/GeneralsX/issues/ ` ), NOT in markdown documentation.
116+
117+ ### Why GitHub is Source of Truth
118+ - ** Single source** : One place to track status, assign ownership, and manage priorities
119+ - ** Versioning** : GitHub automatically tracks discussion history as features evolve
120+ - ** Automation** : CI/CD, PR linking, and automation hooks depend on GitHub issues
121+ - ** Collaboration** : Easier for team members to discover, comment, and contribute
122+ - ** External visibility** : Users and contributors can search and report issues directly
123+
124+ ### Creating New Issues
125+
126+ Use the ` gh issue create ` command to create issues:
127+
128+ ``` bash
129+ gh issue create \
130+ --title " Brief, actionable title" \
131+ --body " ## Context\n...\n## Goal\n...\n## Acceptance Criteria\n..." \
132+ --label " enhancement" \
133+ --label " Linux"
134+ ```
135+
136+ ** Labels** (always apply 1-2):
137+ - ` enhancement ` — New feature or improvement
138+ - ` bug ` — Something isn't working
139+ - ` documentation ` — Documentation improvements
140+ - ` Linux ` , ` macOS ` — Platform-specific
141+ - ` Generals ` , ` Zero Hour ` — Game variant
142+ - ` Blocker ` — Blocks other work
143+ - See ` .github/instructions/docs.instructions.md ` for complete label reference
144+
145+ ### Markdown Documentation (Legacy)
146+
147+ Older ` .md ` files in ` docs/KNOWN_ISSUES/ ` are ** DEPRECATED** .
148+ - ** Do NOT** create new markdown issue files
149+ - ** Remove** files that duplicate active GitHub issues
150+ - ** Archive** resolved issues in GitHub, then delete the ` .md ` file
151+ - ** Migrate** any investigation findings to GitHub issue comments
152+
153+ ### Deleted/Resolved/Archived Issues
154+
155+ If an issue is closed/resolved in GitHub:
156+ 1 . Close the issue on GitHub with appropriate resolution
157+ 2 . Delete the corresponding ` .md ` file from ` docs/KNOWN_ISSUES/ `
158+ 3 . Do NOT keep markdown copies of resolved issues
159+
160+ ### Legacy ` .md ` Issues (Historical Reference)
161+
162+ If you need to reference older markdown issues for historical context:
163+ - Keep in ` docs/ETC/archive/ ` (not ` docs/KNOWN_ISSUES/ ` )
164+ - Update the path and add a note that these are archived
165+ - Do not maintain these going forward
152166
153167### ` docs/ETC/ ` - Reference & Historical Materials
154168** Purpose** : Older reference materials, archived analysis, and miscellaneous documentation
0 commit comments