Skip to content

Commit 1df7d4a

Browse files
committed
add CLAUDE.md
1 parent 1113a6a commit 1df7d4a

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

CLAUDE.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# CLAUDE.md
2+
3+
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
4+
5+
## Pebble Development Environment
6+
7+
Pebble is a LevelDB/RocksDB inspired key-value store focused on
8+
performance and internal usage by CockroachDB.
9+
10+
## Testing
11+
```bash
12+
go test -tags invariants .
13+
go test -tags invariants ./...
14+
```
15+
16+
## Regenerating test files
17+
```bash
18+
go test -tags invariants ./<package> --rewrite
19+
```
20+
21+
## Linting
22+
```bash
23+
go test -tags invariants ./internal/lint"
24+
```
25+
26+
## When generating PRs and commit records
27+
28+
- Follow the format:
29+
- Separate the subject from the body with a blank line.
30+
- Use the body of the commit record to explain what existed before your change, what you changed, and why.
31+
- Prefix the subject line with the package in which the bulk of the changes occur.
32+
- For multi-commit PRs, summarize each commit in the PR record.
33+
- Do not include a test plan unless explicitly asked by the user.
34+
35+
## Interaction Style
36+
37+
* Be direct and honest.
38+
* Skip unnecessary acknowledgments.
39+
* Correct me when I'm wrong and explain why.
40+
* Suggest better alternatives if my ideas can be improved.
41+
* Focus on accuracy and efficiency.
42+
* Challenge my assumptions when needed.
43+
* Prioritize quality information and directness.

0 commit comments

Comments
 (0)