AI docs: add Claude Code project configuration#3326
Closed
martin-belanger wants to merge 1 commit intolinux-nvme:masterfrom
Closed
AI docs: add Claude Code project configuration#3326martin-belanger wants to merge 1 commit intolinux-nvme:masterfrom
martin-belanger wants to merge 1 commit intolinux-nvme:masterfrom
Conversation
Add CLAUDE.md and .claude/rules/ to give AI coding assistants shared, project-scoped context. These files are intentionally committed so all contributors benefit from the same guidance without each having to rebuild it from scratch. CLAUDE.md covers project layout, build system, command and plugin architecture, code style, libnvme internals, testing, and CI. .claude/rules/ adds five rule files with actionable constraints that go beyond background knowledge: - commit-messages.md commit format and Signed-off-by requirement - license-headers.md SPDX identifier selection (GPL vs LGPL by dir) - api-naming.md libnvme_ vs libnvmf_ prefix rules and ABI impact - accessor-workflow.md when/how to regenerate accessors; .ld hygiene - git-workflow.md never commit or push without explicit approval .gitignore is extended to track the shared files above while excluding personal overrides (CLAUDE.local.md, .claude/settings.local.json) and session-local data (.claude/memory/, .claude/todos/). Signed-off-by: Martin Belanger <Martin.Belanger@dell.com> Assisted-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Author
|
Closing as per our discussion this belongs in a separate repo |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add project-scoped Claude Code configuration so that AI coding assistants get consistent, accurate context about this repository out of the box. These files are intentionally committed and shared with all contributors — anyone using Claude Code (CLI, IDE extension, or web) will benefit automatically.
What is added
CLAUDE.md— a project guide loaded by Claude at the start of every session. Covers:OPT_*macros,NVME_ARGS).claude/rules/— five rule files with actionable constraints that go beyond background knowledge:commit-messages.md<subject>: <summary>format;Signed-off-byrequirement;Assisted-bytag when AI-assistedlicense-headers.mdLGPL-2.1-or-laterforlibnvme/;GPL-2.0-or-laterfor CLI and pluginsapi-naming.mdlibnvme_vslibnvmf_prefix rules and their ABI consequencesaccessor-workflow.md.ldversion-section rulesgit-workflow.md.gitignore— extended to track the shared files above while excluding personal/local overrides that must not be committed:CLAUDE.local.md
.claude/settings.local.json
.claude/memory/
.claude/todos/
What is intentionally NOT included
settings.local.jsonstays in the parent directory, outside the repo)memory/,todos/) — ephemeral and user-specific