|
| 1 | += Claude Sandbox |
| 2 | +:toc: left |
| 3 | +:toclevels: 2 |
| 4 | +:source-highlighter: pygments |
| 5 | + |
| 6 | +== Overview |
| 7 | + |
| 8 | +The Claude Sandbox repository is a testing and demonstration environment for the https://github.com/anthropics/claude-code-action[Claude Code GitHub Action]. This repository serves as a workspace for experimenting with Claude's automated code assistance capabilities within GitHub Issues and Pull Requests. |
| 9 | + |
| 10 | +== Purpose |
| 11 | + |
| 12 | +This sandbox enables: |
| 13 | + |
| 14 | +* Testing Claude Code integration with GitHub workflows |
| 15 | +* Demonstrating Claude's ability to assist with software development tasks |
| 16 | +* Exploring automated code review and implementation features |
| 17 | +* Validating Claude Code Action configurations |
| 18 | + |
| 19 | +== Repository Structure |
| 20 | + |
| 21 | +The repository maintains a minimal structure focused on Claude Code integration: |
| 22 | + |
| 23 | +---- |
| 24 | +. |
| 25 | +├── .github/ |
| 26 | +│ └── workflows/ |
| 27 | +│ └── claude.yml # Claude Code GitHub Action workflow |
| 28 | +├── CLAUDE.md # Coding standards and documentation guidelines |
| 29 | +└── README.adoc # This file |
| 30 | +---- |
| 31 | + |
| 32 | +== Claude Code Integration |
| 33 | + |
| 34 | +This repository uses the Claude Code GitHub Action to enable AI-assisted development. Claude can be triggered by mentioning `@claude` in: |
| 35 | + |
| 36 | +* Issue comments |
| 37 | +* Pull request comments |
| 38 | +* Pull request review comments |
| 39 | +* Issue descriptions |
| 40 | + |
| 41 | +=== Workflow Configuration |
| 42 | + |
| 43 | +The Claude Code workflow (`.github/workflows/claude.yml`) is configured with: |
| 44 | + |
| 45 | +* Automatic triggering on `@claude` mentions |
| 46 | +* Write permissions for contents, pull requests, and issues |
| 47 | +* Read permissions for GitHub Actions (CI results) |
| 48 | + |
| 49 | +== Development Guidelines |
| 50 | + |
| 51 | +=== Code Style |
| 52 | + |
| 53 | +This repository follows Boost C++ Libraries conventions as documented in `CLAUDE.md`: |
| 54 | + |
| 55 | +* *Language*: C++11 unless otherwise specified |
| 56 | +* *Naming*: snake_case (Boost C++ Libraries style) |
| 57 | +* *Indentation*: 4 spaces, no tabs |
| 58 | +* *Braces*: On their own line for classes and functions |
| 59 | +* *Encapsulation*: Symbols in "detail" namespaces are never public |
| 60 | + |
| 61 | +=== Project Structure |
| 62 | + |
| 63 | +* *Public headers*: `include/` directory |
| 64 | +* *Library implementation*: `src/` directory |
| 65 | +* *Documentation*: Javadoc style following Boost conventions |
| 66 | + |
| 67 | +=== Documentation Standards |
| 68 | + |
| 69 | +Function and class documentation follows Boost Javadoc style: |
| 70 | + |
| 71 | +* Brief descriptions start on first line after `\/**` |
| 72 | +* Functions returning values: brief starts with "Return" |
| 73 | +* Use `@param` for function parameters |
| 74 | +* Use `@tparam` for template parameters (except variadic args and deduced types) |
| 75 | +* Use `@return`, `@pre`, `@post`, `@throws`, `@note`, `@see` as appropriate |
| 76 | +* Use `@code` / `@endcode` for examples |
| 77 | + |
| 78 | +== Usage |
| 79 | + |
| 80 | +To interact with Claude in this repository: |
| 81 | + |
| 82 | +[source,text] |
| 83 | +---- |
| 84 | +@claude <your request> |
| 85 | +---- |
| 86 | + |
| 87 | +Example requests: |
| 88 | + |
| 89 | +* "@claude Review this code for potential issues" |
| 90 | +* "@claude Implement a function to calculate buffer size" |
| 91 | +* "@claude Create unit tests for the new feature" |
| 92 | +* "@claude Explain how this algorithm works" |
| 93 | + |
| 94 | +== Organization |
| 95 | + |
| 96 | +This repository is maintained by the https://cppalliance.org[C++ Alliance], an organization dedicated to supporting and advancing the C++ programming language and its ecosystem. |
| 97 | + |
| 98 | +== License |
| 99 | + |
| 100 | +[NOTE] |
| 101 | +==== |
| 102 | +License information to be added based on project requirements. |
| 103 | +==== |
| 104 | + |
| 105 | +== Contributing |
| 106 | + |
| 107 | +This is a sandbox repository for testing purposes. For information about contributing to C++ Alliance projects, please visit https://cppalliance.org. |
| 108 | + |
| 109 | +== Resources |
| 110 | + |
| 111 | +* https://github.com/anthropics/claude-code-action[Claude Code GitHub Action] |
| 112 | +* https://www.boost.org/development/requirements.html[Boost C++ Libraries Requirements] |
| 113 | +* https://cppalliance.org[C++ Alliance] |
0 commit comments