miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity
nx/.claude/commands/issue-workflow-guide.md
Jason Jean 8cec6ceebb
chore(repo): setup claude code (#31380) 
## Summary

This PR integrates Claude Code AI assistant capabilities into the Nx
repository through GitHub Actions and workspace configuration.

## Changes Made

### 🤖 GitHub Actions Integration
- **Added `.github/workflows/claude.yml`**: GitHub Actions workflow that
triggers Claude Code on:
  - Issue comments containing `@claude`
  - Pull request review comments containing `@claude` 
  - Pull request reviews containing `@claude`
  - New issues with `@claude` in title or body
- Configured appropriate permissions for repository access and PR/issue
management
- See [Claude Code GitHub Actions
documentation](https://docs.anthropic.com/en/docs/claude-code/cli-usage#github-actions)
for usage details

### 📝 Project Documentation & Configuration
- **Added `CLAUDE.md`**: Comprehensive instructions for Claude Code
including:
  - Repository-specific guidance and best practices
  - Essential commands for development workflow
- Testing procedures (individual projects → affected projects → e2e
tests)
  - GitHub issue resolution workflow
  - Pre-push validation requirements
- **Added `.claude/settings.json`**: Claude Code permissions and
environment configuration
- **Added `.mcp.json`**: Model Context Protocol server configuration for
Nx workspace integration

### 🔧 Workspace Setup
- **Updated `package.json`**: Added `nx-mcp` dependency for enhanced
workspace integration
- **Updated `pnpm-lock.yaml`**: Lock file changes for new dependency
- **Updated `.gitignore`**: Added Claude-specific ignore patterns
- **Updated `CODEOWNERS`**: Assigned ownership of Claude-related files
to @FrozenPandaz
- **Updated `CONTRIBUTING.md`**: Enhanced contribution guidelines with
technology stack information

## Benefits

- Enables AI-assisted development and issue resolution through GitHub
- Provides Claude with deep understanding of Nx workspace structure via
MCP
- Establishes clear development workflows and validation procedures
- Maintains security through configured permissions and environment
settings

## Usage

After this PR is merged, team members and contributors can:
1. Comment `@claude` in issues or PRs to get AI assistance
2. Use Claude Code locally with enhanced Nx workspace understanding
3. Follow established workflows for testing and validation

For more information, see the [Claude Code
documentation](https://docs.anthropic.com/en/docs/claude-code).

## Test Plan

- [x] Verify GitHub Actions workflow syntax is valid
- [x] Confirm Claude Code configuration files are properly structured
- [x] Validate new dependency integration
- [x] Test workflow triggers on issue/PR interactions

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-05-30 18:14:11 -04:00

1.3 KiB
Raw Blame History

Claude Issue Workflow Usage Guide

Quick Start

For Planning Phase

  1. Comment @claude plan on any issue, OR
  2. Add the label claude:plan to trigger automatic planning

For Implementation Phase

  1. Comment @claude implement on an issue with a plan, OR
  2. Add the label claude:implement to trigger automatic implementation

Workflow Labels

  • claude:plan - Triggers the planning workflow
  • claude:planned - Added after planning is complete
  • claude:implement - Triggers the implementation workflow
  • claude:implemented - Added after implementation is complete

Expected Outputs

Planning Phase

  • Detailed analysis comment posted to issue
  • Implementation plan with steps and file changes
  • Testing strategy and validation steps
  • Risk assessment

Implementation Phase

  • Code changes made according to plan
  • Tests run and validated
  • Feature branch created: fix/issue-{number}
  • PR suggestion with proper title format

Manual Override

If you need to work on an issue manually, use the /gh-issue-plan command for structured guidance following the same workflow patterns.

Troubleshooting

  • Ensure you're on the authorized users list
  • Check that the issue has sufficient detail for analysis
  • For implementation, ensure a plan comment exists from the planning phase
  • If workflows fail, check the Actions tab for detailed logs