Skip to content

docs: add CLAUDE.md#535

Merged
beekld merged 3 commits into
mainfrom
beeklimt/claude-md
May 15, 2026
Merged

docs: add CLAUDE.md#535
beekld merged 3 commits into
mainfrom
beeklimt/claude-md

Conversation

@beekld
Copy link
Copy Markdown
Contributor

@beekld beekld commented May 15, 2026

This is a CLAUDE.md based on things I've had to tell claude while working in this codebase. Some of the instructions are due to quirks with this particular repo. Some are coding conventions where I think it would be helpful for us to be more explicit and opinionated. Feel free to push back on any of this, or to suggest other things I've missed.


Note

Low Risk
Documentation-only change adding contributor guidance; no runtime or build logic is modified.

Overview
Adds a new CLAUDE.md with repo-specific guidance for building and testing (CMake usage, sanitizer quirks, networking backend validation, GTest targets/timeouts), plus additional coding conventions around includes, public API stability, parameters, thread-safety, futures, tests, docs, formatting, and PR/commit hygiene.

Reviewed by Cursor Bugbot for commit 0569d8d. Bugbot is set up for automated code reviews on this repo. Configure here.

@beekld beekld requested a review from a team as a code owner May 15, 2026 17:45
Comment thread CLAUDE.md Outdated

## Process

- **Commit messages:** single-line conventional commits (`feat:`, `fix:`, `refactor:`, `docs:`, `chore:`, `test:`). No body unless asked. No `Co-Authored-By: Claude` trailer.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'd remove the part about co-authoring, being as this doesn't generally work.

@beekld beekld merged commit 261ba85 into main May 15, 2026
6 checks passed
@beekld beekld deleted the beeklimt/claude-md branch May 15, 2026 18:08
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