feat(guide): comprehensive improvements - troubleshooting, CLI ref, pitfalls, DeepSeek
MAJOR ENHANCEMENTS: ## README Updates - Add pedagogical approach section emphasizing learning journey over reference manual - Reference zebbern/claude-code-guide as key inspiration for troubleshooting - Clarify guide philosophy: mentor for mastering Claude Code ## Main Guide (english-ultimate-claude-code-guide.md) ### New Sections Added: 1. **Status Overview Table** - Section completeness at a glance 2. **Section 10.3: CLI Flags Complete Reference** - 19 flags with descriptions and examples - Common flag combinations - Safety guidelines table 3. **Section 10.4: Enhanced MCP Troubleshooting** - 3 common errors with solutions (tool validation, server not found, Windows paths) - MCP debugging techniques (logs, manual testing) - One-shot health check scripts (PowerShell + Bash) - Full clean reinstall procedures (Windows + macOS/Linux) 4. **Section 9.11: Common Pitfalls & Best Practices** - Security pitfalls (Do/Don't + working hook example) - Performance pitfalls (context strategy, thinking levels) - Workflow pitfalls (prompt format template) - Collaboration pitfalls (team coordination) - Cost optimization pitfalls (model selection table) - Learning pitfalls (progressive adoption checklist) 5. **Section 11: DeepSeek Integration** - Complete setup (Windows/macOS/Linux) - Cost comparison (98% savings) - Use cases and limitations - Provider switching strategies 6. **Appendix A: File Locations Reference** - Platform-specific paths (Windows/macOS/Linux) - Quick access commands - Environment variables reference - Recommended .gitignore ## Cheatsheet (cheatsheet-en.md) - Add CLI Flags Quick Reference table - Add Common Issues Quick Fix table - Add Health Check one-liners - Add Cost Optimization section - Update to version 2.0 ## GitHub Actions (examples/github-actions/) - **claude-pr-auto-review.yml**: Comprehensive review workflow - 8 focus areas (correctness, security, performance, etc.) - Priority-based feedback (🔴🟡🟢💡) - Smart file filtering - Draft PR detection - Error handling + fallback comments - **README.md**: Update workflow #1 documentation with new features ## Documentation Quality - All examples are practical and tested - Platform-specific instructions throughout - Do/Don't format for quick scanning - Cross-references to zebbern guide where appropriate - Maintains pedagogical tone established in original guide IMPACT: Guide now provides exceptional troubleshooting resources, complete CLI reference, real-world integration patterns, and cost-effective alternatives while maintaining focus on learning journey. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This commit is contained in:
parent
87994bb797
commit
2f84c2a769
5 changed files with 1261 additions and 22 deletions
|
|
@ -15,12 +15,19 @@ Ready-to-use GitHub Actions workflows that integrate Claude Code into your CI/CD
|
|||
|
||||
### 1. Auto PR Review (`claude-pr-auto-review.yml`)
|
||||
|
||||
**Enhanced version** with comprehensive review criteria and smart filtering.
|
||||
|
||||
Creates a structured review with inline comments as soon as a PR opens or updates.
|
||||
|
||||
**Features:**
|
||||
- Automatic code review on PR open/update
|
||||
- 8 focus areas: Correctness, Security, Performance, Readability, Maintainability, Testing, Best Practices, Breaking Changes
|
||||
- Priority-based feedback: 🔴 Critical, 🟡 Important, 🟢 Suggestion, 💡 Tip
|
||||
- Smart file filtering (skips build artifacts, lock files)
|
||||
- Skips draft PRs to save costs
|
||||
- Summary review with risk assessment
|
||||
- Error handling and fallback notifications
|
||||
- Inline comments on specific lines
|
||||
- Reviews for correctness, readability, testing, performance, DX
|
||||
|
||||
**Usage:**
|
||||
```bash
|
||||
|
|
@ -30,6 +37,17 @@ cp examples/github-actions/claude-pr-auto-review.yml .github/workflows/
|
|||
# Open a PR - Claude will automatically review it
|
||||
```
|
||||
|
||||
**Customization:**
|
||||
Add project-specific context by uncommenting the `append_system_prompt` section:
|
||||
```yaml
|
||||
append_system_prompt: |
|
||||
Project conventions:
|
||||
- Use TypeScript strict mode
|
||||
- Follow functional programming patterns
|
||||
- All functions must have JSDoc comments
|
||||
- Test coverage must be >80%
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 2. Security Review (`claude-security-review.yml`)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue