forked from Futu-reADS/multigo_navigation_baseline
-
Notifications
You must be signed in to change notification settings - Fork 0
Closed
Description
Overview
Implement the complete prompt and workflow automation solution from workflow-system template repository.
This builds on Task 2 (GitHub Actions workflows) by adding:
- CLAUDE.md project instructions
- .claude/WORKFLOW.md comprehensive workflow guide
- .claude/hooks/ automation scripts
- Helper scripts for development workflow
Reference
- Based on experimentation from: https://github.com/PankajTanwar7/task-manager-demo
- Template repository: https://github.com/PankajTanwar7/workflow-system
- Parent issue: AI Integration and Documentation Workflow for main_ai Branch #1
Scope
Core Files to Integrate
1. CLAUDE.md (Project Instructions)
- Enforces workflow at session start
- Project-specific guidance for Claude
- Testing requirements
- Architecture patterns
- ~270 lines
2. .claude/WORKFLOW.md (Complete Workflow Documentation)
- Single source of truth for development process
- Phase-by-phase workflow guide
- Automation script documentation
- ~750+ lines
3. .claude/hooks/ (Automation Scripts)
post-summary.sh- Post progress comments to GitHub- Hook configurations in
.claude/settings.json
4. scripts/ (Helper Scripts)
start-work.sh- Create feature branch from issuecleanup-after-merge.sh- Post-merge cleanup- Automated branch naming
5. Documentation
AUTOMATION-FAQ.md- Automation details and Q&AHOOKS-SETUP.md- Hook configuration guide- Other workflow documentation as needed
Customization Required
CLAUDE.md Placeholders:
{YOUR_REPO_NAME} → multigo_navigation_ai_integrated
{YOUR_PROJECT_TYPE} → ROS Navigation System with AI Integration
{YOUR_TEST_COMMAND} → (TBD: catkin_make test / colcon test / rostest)
{YOUR_PROJECT_DESCRIPTION} → Multi-Go autonomous robot navigation
Project-Specific Updates:
- Adapt for ROS project structure
- Update architecture section for navigation system
- Configure testing approach (ROS-specific)
- Update file references for this codebase
Acceptance Criteria
- CLAUDE.md created with all placeholders replaced
- .claude/WORKFLOW.md integrated and customized
- .claude/hooks/ scripts added and configured
- scripts/ helper scripts added and made executable
- Documentation files added (AUTOMATION-FAQ.md, HOOKS-SETUP.md)
- .claude/settings.json configured with hooks
- All scripts tested and working
- PR created targeting
mainbranch - Documentation updated with setup instructions
Notes
What NOT to Include (Already Done in Task 2):
- ❌ .github/workflows/ (already integrated)
- ❌ GITHUB-CLAUDE-SETUP.md (already added)
- ❌ OAuth token setup (already configured)
Focus Areas:
- ✅ CLAUDE.md project instructions
- ✅ .claude/WORKFLOW.md workflow guide
- ✅ Automation hooks and scripts
- ✅ Development helper scripts
- ✅ Workflow documentation
Testing Approach (TBD)
Need to determine:
- ROS testing framework in use (catkin/colcon)
- Test command to use
- Build system configuration
Related
- Closes part of AI Integration and Documentation Workflow for main_ai Branch #1 (Parent issue)
- Builds on Task 2: Integrate Claude with updated claude.yml and claude-code-review.yml #2 (GitHub Actions integration)
- Template: https://github.com/PankajTanwar7/workflow-system
Metadata
Metadata
Assignees
Labels
No labels