|
| 1 | +# LLM.md - AI-Assisted Contribution Guidelines |
| 2 | + |
| 3 | +This document outlines the requirements for contributions that involve AI assistance in this project. |
| 4 | + |
| 5 | +## Assisted-by Tag Requirement |
| 6 | + |
| 7 | +When AI tools are used during development, the source must be clearly documented so everyone can understand the extent of AI involvement in each submission. All code contributions involving AI assistance must include an `Assisted-by` tag using the following format: |
| 8 | + |
| 9 | +``` |
| 10 | +Assisted-by: AGENT_NAME:MODEL_VERSION [TOOL1] [TOOL2] |
| 11 | +``` |
| 12 | + |
| 13 | +### Format Specification |
| 14 | + |
| 15 | +| Component | Description | |
| 16 | +|-----------|-------------| |
| 17 | +| `AGENT_NAME` | The name of the AI tool or framework used (e.g., Claude, OpenClaw, Copilot) | |
| 18 | +| `MODEL_VERSION` | The specific model version (e.g., claude-3-opus, gemini-2.5-pro, k2p5) | |
| 19 | +| `[TOOL1] [TOOL2]` | Optional: Additional specialized analysis tools used (e.g., coccinelle, sparse, smatch, clang-tidy) | |
| 20 | + |
| 21 | +### Notes |
| 22 | + |
| 23 | +- **Do not include** common everyday tools like git, gcc, make, or text editors |
| 24 | +- Only list specialized analysis or transformation tools that significantly contributed to the code |
| 25 | +- Multiple `Assisted-by` tags may be used if different AI tools were used for different parts of the contribution |
| 26 | + |
| 27 | +### Examples |
| 28 | + |
| 29 | +**Using Claude with coccinelle and sparse:** |
| 30 | +``` |
| 31 | +Assisted-by: Claude:claude-3-opus coccinelle sparse |
| 32 | +``` |
| 33 | + |
| 34 | +**Using OpenClaw with no additional tools:** |
| 35 | +``` |
| 36 | +Assisted-by: OpenClaw:k2p5 |
| 37 | +``` |
| 38 | + |
| 39 | +**Using GitHub Copilot:** |
| 40 | +``` |
| 41 | +Assisted-by: Copilot:gpt-4o |
| 42 | +``` |
| 43 | + |
| 44 | +**Multiple AI tools used:** |
| 45 | +``` |
| 46 | +Assisted-by: Claude:claude-3-opus clang-tidy |
| 47 | +Assisted-by: OpenClaw:gemini-3.1-pro-preview |
| 48 | +``` |
| 49 | + |
| 50 | +## Where to Include |
| 51 | + |
| 52 | +Add the `Assisted-by` tag(s) at the end of your commit message, after the sign-off line (if present): |
| 53 | + |
| 54 | +``` |
| 55 | +Fix memory leak in request handler |
| 56 | +
|
| 57 | +This patch fixes a use-after-free bug in the async request handler |
| 58 | +that could occur during rapid create/destroy cycles. |
| 59 | +
|
| 60 | +Signed-off-by: John Doe <john@example.com> |
| 61 | +Assisted-by: Claude:claude-3-opus coccinelle sparse |
| 62 | +``` |
| 63 | + |
| 64 | +## Why This Matters |
| 65 | + |
| 66 | +1. **Transparency**: Maintainers and reviewers should know when AI has assisted in code creation |
| 67 | +2. **Attribution**: Proper credit for AI contributions helps track the evolution of development practices |
| 68 | +3. **Quality Assurance**: Understanding AI involvement helps set appropriate review standards |
| 69 | +4. **Audit Trail**: Creates a clear record for future reference and analysis |
| 70 | + |
| 71 | +## Scope |
| 72 | + |
| 73 | +This requirement applies to: |
| 74 | +- Code changes (any language) |
| 75 | +- Configuration files |
| 76 | +- Build scripts |
| 77 | +- Documentation (if substantially AI-generated) |
| 78 | + |
| 79 | +This requirement does **not** apply to: |
| 80 | +- Minor typo fixes |
| 81 | +- Pure formatting changes |
| 82 | +- Changes made entirely without AI assistance |
0 commit comments