Skip to content

docs: add CLAUDE.md for Claude Code guidance#338

Merged
Molter73 merged 2 commits into
mainfrom
mauro/claude-config
May 21, 2026
Merged

docs: add CLAUDE.md for Claude Code guidance#338
Molter73 merged 2 commits into
mainfrom
mauro/claude-config

Conversation

@Molter73
Copy link
Copy Markdown
Collaborator

Description

Add comprehensive documentation for future Claude Code instances working in this repository. Includes project overview, workspace structure, architecture patterns, and common commands for building, running, and testing. Emphasizes pytest integration tests in tests/ directory as the preferred testing approach for agents (no sudo required).

Assisted-by: Claude Sonnet 4.5 noreply@anthropic.com

Checklist

  • Investigated and inspected CI test results
  • Updated documentation accordingly

Automated testing

  • Added unit tests
  • Added integration tests
  • Added regression tests

If any of these don't apply, please comment below.

Testing Performed

None. Will try out how claude behaves with this file in future PRs.

Add comprehensive documentation for future Claude Code instances working
in this repository. Includes project overview, workspace structure,
architecture patterns, and common commands for building, running, and
testing. Emphasizes pytest integration tests in tests/ directory as the
preferred testing approach for agents (no sudo required).

Assisted-by: Claude Sonnet 4.5 <noreply@anthropic.com>
@Molter73 Molter73 requested a review from a team as a code owner February 27, 2026 11:08
Use the attribution setting for commits to add the `Assisted-by` trailer
when Claude creates a commit.

Add .claude/*.local.* pattern to .gitignore to exclude Claude Code local
configuration files from version control.

Assisted-by: Claude Sonnet 4.5 <noreply@anthropic.com>
@Molter73 Molter73 force-pushed the mauro/claude-config branch from bc4f3ea to 5fa5c16 Compare February 27, 2026 11:40
@Molter73 Molter73 enabled auto-merge (squash) March 2, 2026 10:18
Copy link
Copy Markdown
Contributor

@Stringy Stringy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couple of very minor points but otherwise LGTM.

Comment thread CLAUDE.md
- **fact-api**: gRPC API definitions generated from protobuf files in `third_party/stackrox/proto`

- **fact-ebpf**: BPF program implementation
- `src/bpf/*.c`: C code for BPF programs that attach to LSM hooks
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

might be worth including *.h here too - or simplify to src/bpf/*.{c,h}

Comment thread CLAUDE.md
1. Kernel LSM hooks trigger BPF programs (in `fact-ebpf/src/bpf/main.c`)
2. BPF programs write events to ring buffer
3. `Bpf` worker (in `fact/src/bpf/mod.rs`) reads from ring buffer, sends to channel
4. `HostScanner` (in `fact/src/host_scanner.rs`) enriches events with process info
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this might need to be updated to include rate limiting

@Molter73 Molter73 merged commit 0e170db into main May 21, 2026
24 checks passed
@Molter73 Molter73 deleted the mauro/claude-config branch May 21, 2026 10:42
@Molter73
Copy link
Copy Markdown
Collaborator Author

Couple of very minor points but otherwise LGTM.

Forgot auto-merge was on, I'll create a follow up PR with the comments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants