diff --git a/.gitignore b/.gitignore index 4f77eaa..2194154 100644 --- a/.gitignore +++ b/.gitignore @@ -25,3 +25,4 @@ npm-debug.log* to-ignore/ .grepai/ whitepapers/ +claudedocs/ diff --git a/CHANGELOG.md b/CHANGELOG.md index 9eba7e8..12767fb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,48 +6,48 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). ## [Unreleased] +--- + +## [3.8.0] - 2026-01-16 + ### Added -- **Dev With AI community reference** in README.md - - French-speaking community for developers of all levels and tech stacks - - ~1500 members on Slack, meetups in Paris, Bordeaux, Lyon - - Link: https://www.devw.ai/ +- **TL;DR Quick Start section** in README.md + - Quick reference table: Cheat Sheet (2 min), Starter CLAUDE.md (30 sec), 5 Rules (1 min) + - Copy-paste CLAUDE.md template directly in README + - Optimized for TTFV (Time-to-First-Value) < 5 minutes + - Prominent badges at top: version, license, Claude Code support -- **Whitepaper #6 Privacy & Compliance - Expanded IP Section** - - Comprehensive "Intellectual Property Considerations" section - - Copyright du code généré par IA: ownership ambiguity, registrability, derived works - - License contamination risks: GPL, AGPL, MIT/BSD, Apache 2.0 analysis - - Enterprise indemnification coverage by plan tier - - Best practices for IP risk mitigation (documentation, review, scanning, policy) - - File: `whitepapers/06-privacy.qmd` +- **French Whitepapers documentation** in README.md + - New section documenting 8 whitepapers in French (~185 pages total) + - Learning paths by profile: Junior (25 min), Senior (1h15), Tech Lead (1h15) + - Files in `whitepapers/` directory using Quarto (.qmd) format -- **Onboarding Prompt v2: Adaptive Pedagogy & Multi-LLM Support** - - **New "Communication Tone" question** in Phase 0 (after goal) - - 4 options: Pedagogical, Direct, Coaching, Adaptive - - Adapts HOW content is delivered (not just WHAT) - - **Style preference now universal** - offered to all goals when time >= 15min (was 30min, learn_everything only) - - **"Reset" option in depth control** - users can restart with different preferences anytime - - **"Skip" now shows what's skipped** - brief note about skipped content for future reference - - **Fallback handling** if reference.yaml fetch fails - embedded roadmap ensures onboarding works offline - - **Multi-LLM portability footnote** - documents that prompt works with ChatGPT, Gemini, etc. - - **Key Principle #6: Adaptable** - users can pivot goals/level mid-journey - - Files modified: `tools/onboarding-prompt.md`, `machine-readable/reference.yaml` - - Inspired by community feedback (Greg Lhotellier testing on ChatGPT) +- **CODE_OF_CONDUCT.md** (new file) + - Contributor Covenant v2.1 + - Standard OSS community guidelines -- **grepai MCP Server documentation** in `guide/ultimate-guide.md` (Section 8.3) - - Privacy-first semantic code search using Ollama embeddings - - Call graph analysis: trace callers, callees, and dependency graphs - - Combined workflow with Serena for exploration + precise editing - - Setup instructions with Ollama and grepai CLI - - MCP tools reference: `grepai_search`, `grepai_trace_callers`, `grepai_trace_callees`, `grepai_trace_graph` - - Source: [grepai GitHub](https://github.com/yoanbernabeu/grepai) -- Updated MCP server decision tree and comparison table to include grepai -- Added grepai configuration to `examples/config/mcp.json` -- **grepai vs grep/rg benchmark comparison** in Section 8.4 - - Performance comparison table: rg (~20ms) vs grep (~45ms) vs grepai (~500ms) - - Key insight documented: grepai finds what pattern-based tools cannot - - Decision tree updated with "Know exact pattern?" branch (use rg/Grep) - - Server Comparison table updated with exact match recommendation +- **Distribution playbooks** (internal, gitignored) + - `claudedocs/distribution-playbook.md`: Ready-to-use content for awesome-claude-code PR, Reddit, dev.to, Twitter + - `claudedocs/github-discussions-setup.md`: Step-by-step GitHub Discussions setup + - French distribution strategy: Dev With AI Slack, LinkedIn FR + +### Changed + +- **CONTRIBUTING.md completely rewritten** + - Added welcome message and contribution types table + - Clear PR process with checklist + - Quality checklist before submitting + - References to GitHub Discussions and Code of Conduct + +- **README.md restructured** + - "Why This Guide" section rewritten for clarity + - Repository structure updated to include whitepapers/ + - Dev With AI community reference added + +### Internal + +- Added `claudedocs/` and `whitepapers/` to `.gitignore` (internal docs) --- diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..302476f --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,60 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior: + +* The use of sexualized language or imagery and unwelcome sexual attention +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information without explicit permission +* Other conduct which could reasonably be considered inappropriate + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +[florian.bruniaux@gmail.com](mailto:florian.bruniaux@gmail.com). + +All complaints will be reviewed and investigated promptly and fairly. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c3dc8fe..1b03359 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,46 +1,93 @@ -# Contributing to The Ultimate Claude Code Guide +# Contributing to Claude Code Ultimate Guide -Thank you for your interest in improving this guide! Every contribution helps make Claude Code more accessible to developers worldwide. +**Welcome!** Whether you're fixing a typo or adding a new section, every contribution helps developers worldwide master Claude Code. -## How to Contribute +## Quick Links -### Reporting Issues +- [Report an Issue](../../issues/new) +- [Start a Discussion](../../discussions) +- [Code of Conduct](./CODE_OF_CONDUCT.md) -Found an error, outdated information, or have a suggestion? +--- -1. **Check existing issues** - Someone may have reported it already +## Ways to Contribute + +| Type | Examples | Effort | +|------|----------|--------| +| **Report** | Bugs, outdated info, broken links | 2 min | +| **Improve** | Fix typos, clarify explanations | 5-15 min | +| **Add Examples** | New templates, workflows, hooks | 15-60 min | +| **Translate** | Help reach non-English speakers | Varies | +| **Share** | Your workflows, success stories | 5 min | + +**Not sure where to start?** Check [issues labeled `good first issue`](../../issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22). + +--- + +## Reporting Issues + +Found something wrong or have a suggestion? + +1. **Search existing issues** — Someone may have reported it 2. **Open a new issue** with: - - Clear description of the problem or suggestion - - Location in the guide (section, line if applicable) + - Clear description + - Location (file, section, line) - Your platform (macOS/Linux/Windows) - - For Windows issues: PowerShell version + - For Windows: PowerShell version -### Pull Requests +--- -1. **Fork the repository** -2. **Create a feature branch**: `git checkout -b fix/typo-in-section-3` -3. **Make your changes** -4. **Test on your platform** (especially commands and code snippets) -5. **Submit a PR** with: - - Clear description of changes - - Why the change is needed - - Any testing performed +## Pull Request Process + +### 1. Fork & Clone + +```bash +git clone https://github.com/YOUR_USERNAME/claude-code-ultimate-guide.git +cd claude-code-ultimate-guide +``` + +### 2. Create a Branch + +```bash +git checkout -b fix/typo-in-section-3 +# or +git checkout -b feature/add-debugging-guide +``` + +### 3. Make Changes + +Follow [Content Guidelines](#content-guidelines) below. + +### 4. Test Your Changes + +- Preview markdown rendering +- Test code snippets on your platform +- Verify all links work + +### 5. Submit PR + +Include: +- Clear description of changes +- Why the change is needed +- What you tested + +--- ## Content Guidelines ### Writing Style -- **Be concise** - Prefer bullet points over long paragraphs -- **Be practical** - Include examples for every concept -- **Be inclusive** - Support both macOS/Linux AND Windows users -- **Be accurate** - Test all code snippets before submitting +- **Concise**: Bullet points > long paragraphs +- **Practical**: Include examples for every concept +- **Cross-platform**: Support macOS/Linux AND Windows +- **Accurate**: Test all code before submitting ### Documentation Structure ```markdown ## Section Title -Brief introduction (1-2 sentences max). +Brief intro (1-2 sentences). ### Subsection @@ -49,15 +96,14 @@ Brief introduction (1-2 sentences max). | Data | Data | **Example:** -```code -example here +```bash +code example here ``` ``` -### Code Snippets +### Platform-Specific Code -- **Test before submitting** - All code must work -- **Include both platforms** when commands differ: +Always provide both when commands differ: ```bash # macOS/Linux @@ -67,86 +113,60 @@ example here %USERPROFILE%\.claude\settings.json ``` -### Formatting - -- Use tables for comparisons -- Use code blocks with language hints -- Use `**bold**` for emphasis -- Use `backticks` for inline code -- Reference sections with anchors: `[Section Name](#section-anchor)` - -## Platform-Specific Contributions - -### Windows Contributions (Especially Welcome!) - -The author works on macOS and hasn't tested Windows commands. If you're a Windows user: - -- **Test all PowerShell scripts** with PS 5.1+ -- **Test batch file alternatives** when possible -- **Verify paths** work correctly -- **Report issues** with Windows-specific instructions - -Your contributions are especially valuable! - -### Cross-Platform Guidelines - -- Use `npm` commands (cross-platform) over `curl` (Unix-only) -- Specify paths for both platforms -- Note differences in shell syntax -- Test on your platform, note what you tested +--- ## Quality Checklist -Before submitting a PR, verify: +Before submitting: -- [ ] Markdown renders correctly (preview in GitHub) +- [ ] Markdown renders correctly (preview on GitHub) - [ ] All links work -- [ ] Code snippets are tested +- [ ] Code snippets tested on your platform - [ ] Windows equivalents provided (if applicable) -- [ ] No typos (run spell check) +- [ ] Spell-checked - [ ] Follows existing style -- [ ] Adds value (not just reformatting) -## Types of Contributions +--- -### Quick Fixes (< 5 minutes) -- Typo corrections -- Broken link fixes -- Minor clarifications +## Windows Contributions (Especially Welcome!) -### Enhancements (5-30 minutes) -- Add missing examples -- Improve explanations -- Add Windows equivalents -- Update outdated information +The maintainer works on macOS. If you're a Windows user: -### New Content (30+ minutes) -- New sections or guides -- New example templates -- Translations -- Comprehensive rewrites +- Test PowerShell scripts with PS 5.1+ +- Verify path handling +- Report Windows-specific issues +- Add batch file alternatives when possible -## Not Accepted +**Your contributions are especially valuable!** + +--- + +## What We Don't Accept - Marketing language or promotional content -- Unverified or speculative information -- Breaking changes to structure without discussion -- Large changes without prior issue discussion +- Unverified or speculative claims +- Large structural changes without prior discussion +- Breaking changes to existing examples + +--- ## Recognition Contributors are recognized through: -- **Git history** - Your commits are permanently attributed -- **GitHub contributors** - Visible on the repository page +- **Git history** — Your commits are permanently attributed +- **GitHub contributors** — Visible on repository page -For significant contributions, we may add you to a "Contributors" section. - -## Questions? - -- Open an issue for general questions -- Reach out on [LinkedIn](https://www.linkedin.com/in/florian-bruniaux-43408b83/) for direct contact +Significant contributions may be highlighted in release notes. --- -Thank you for helping improve this guide! +## Questions? + +- **General questions**: [GitHub Discussions](../../discussions) +- **Bug reports**: [Issues](../../issues) +- **Direct contact**: [LinkedIn](https://www.linkedin.com/in/florian-bruniaux-43408b83/) + +--- + +**Thank you for helping improve this guide!** diff --git a/README.md b/README.md index 9881016..55a8c5d 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,44 @@ --- +## ⚡ TL;DR (Under 5 Minutes) + +**In a hurry?** Pick one: + +| I need... | Go here | Time | +|-----------|---------|------| +| **Quick reference** | [Cheat Sheet](./guide/cheatsheet.md) | 2 min | +| **Starter CLAUDE.md** | Copy below ↓ | 30 sec | +| **Key principles** | [5 Rules](#5-rules-to-remember) | 1 min | + +
+📋 Minimal CLAUDE.md Template (click to expand & copy) + +```markdown +# Project: [NAME] + +## Tech Stack +- Language: [e.g., TypeScript] +- Framework: [e.g., Next.js 14] +- Testing: [e.g., Vitest] + +## Commands +- Build: `npm run build` +- Test: `npm test` +- Lint: `npm run lint` + +## Rules +- Run tests before marking tasks complete +- Follow existing code patterns +- Keep commits atomic and conventional +``` + +Save as `CLAUDE.md` in your project root. Claude reads it automatically. + +
+ +--- + **Transparency note**: This guide reflects my personal experience after several months of daily Claude Code usage. I'm sharing what I've learned, not claiming expertise. The tool evolves constantly, and so does my understanding. [Feedback welcome](./CONTRIBUTING.md). --- @@ -351,6 +389,23 @@ Weak Areas (< 75%): | **[Setup Audit](./tools/audit-prompt.md)** | Optimize your configuration | ~10 minutes | | **[Examples Library](./examples/)** | Production-ready templates | Browse as needed | +### 🇫🇷 Whitepapers (French) + +8 standalone documents covering Claude Code from zero to production (~185 pages total): + +| # | Title | Audience | Pages | +|---|-------|----------|-------| +| **[#0](./whitepapers/00-introduction-serie.qmd)** | De Zéro à Productif | Everyone | ~8 | +| **[#1](./whitepapers/01-prompts-efficaces.qmd)** | Prompts qui Marchent | Dev Junior/Senior | ~12 | +| **[#2](./whitepapers/02-personnalisation.qmd)** | Personnaliser Claude | Senior/Power | ~15 | +| **[#3](./whitepapers/03-securite.qmd)** | Sécurité en Production | DevSecOps/TechLead | ~15 | +| **[#4](./whitepapers/04-architecture.qmd)** | L'Architecture Démystifiée | Architects | ~12 | +| **[#5](./whitepapers/05-equipe.qmd)** | Déployer en Équipe | TechLead/PM | ~12 | +| **[#6](./whitepapers/06-privacy.qmd)** | Privacy & Compliance | Compliance/Legal | ~10 | +| **[#7](./whitepapers/07-guide-reference.qmd)** | Guide de Référence Complet | Everyone | ~100 | + +> **Reading paths by profile**: Junior (WP #0→#1, 25 min) | Senior (#0→#1→#2→#3, 1h15) | Tech Lead (#0→#5→#3→#2, 1h15) +
Alternative Formats (Interactive AI, PDFs) @@ -403,6 +458,12 @@ claude-code-ultimate-guide/ │ ├── modes/ # Behavioral modes (SuperClaude) │ └── workflows/ # Advanced workflow guides │ +├── whitepapers/ # 🇫🇷 French whitepaper series (8 docs, ~185 pages) +│ ├── 00-introduction-serie.qmd +│ ├── 01-prompts-efficaces.qmd +│ ├── ... +│ └── 07-guide-reference.qmd +│ └── quiz/ # 🧠 Interactive knowledge quiz (159 questions) ``` diff --git a/VERSION b/VERSION index a76ccff..1981190 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -3.7.1 +3.8.0 diff --git a/assets/claude-code-ai-logo.jpg b/assets/claude-code-ai-logo.jpg new file mode 100644 index 0000000..590b6c8 Binary files /dev/null and b/assets/claude-code-ai-logo.jpg differ