docs: Add Gitea-first workflow guidelines to project documentation
Establish Gitea as the single source of truth for issue tracking, documentation, and project management to improve development efficiency. CLAUDE.md changes: - Add comprehensive "Gitea-First Workflow" section at top of file - Document 5 core principles for using Gitea effectively - Provide workflow pattern diagram for development process - List available Gitea MCP tools for programmatic access - Explain benefits: reduced context switching, better planning, living docs ROADMAP.md changes: - Add "Development Workflow" section referencing Gitea-first approach - Include 5-step checklist for starting any work - Link to detailed workflow guidelines in CLAUDE.md - Emphasize Gitea as single source of truth Workflow principles: 1. Always check Gitea issues/wiki before starting work 2. Create granular, focused issues for new features/problems 3. Document as you go - update related issues when work affects them 4. If docs mislead, create task to correct/expand them 5. Cross-reference everything - commits, issues, wiki pages Benefits: - Avoid re-reading entire codebase by consulting brief issue descriptions - Reduce duplicate or contradictory work through better planning - Maintain living documentation that stays current - Capture historical context and decision rationale - Improve efficiency using MCP tools for programmatic queries This establishes best practices for keeping the project organized and reducing cognitive load during development. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
parent
3c20a6be50
commit
5205b5d7cd
2 changed files with 473 additions and 0 deletions
15
ROADMAP.md
15
ROADMAP.md
|
|
@ -201,6 +201,21 @@ For current status and detailed tasks, see the corresponding Gitea issue labels:
|
|||
- **Source Code**: [Gitea Repository](https://gamedev.ffwf.net/gitea/john/McRogueFace)
|
||||
- **Documentation**: See `CLAUDE.md` for build instructions and development guide
|
||||
- **Tutorial**: See `roguelike_tutorial/` for implementation examples
|
||||
- **Workflow**: See "Gitea-First Workflow" section in `CLAUDE.md` for issue management best practices
|
||||
|
||||
---
|
||||
|
||||
## 🔄 Development Workflow
|
||||
|
||||
**Gitea is the Single Source of Truth** for this project. Before starting any work:
|
||||
|
||||
1. **Check Gitea Issues** for existing tasks, bugs, or related work
|
||||
2. **Create granular issues** for new features or problems
|
||||
3. **Update issues** when work affects other systems
|
||||
4. **Document discoveries** - if something is undocumented or misleading, create a task to fix it
|
||||
5. **Cross-reference commits** with issue numbers (e.g., "Fixes #104")
|
||||
|
||||
See the "Gitea-First Workflow" section in `CLAUDE.md` for detailed guidelines on efficient development practices using the Gitea MCP tools.
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue