Skip to content

Commit ecf8c05

Browse files
committed
Add basic CLAUDE.md file
We add a basic `CLAUDE.md` file pointing it to some workspace specifics (in particular running `cargo fmt` on 1.75.0 MSRV, and using `./ci/ci-tests.sh` to run tests). Signed-off-by: Elias Rohrer <dev@tnull.de>
1 parent 9e91b2e commit ecf8c05

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

CLAUDE.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# CLAUDE.md
2+
3+
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
4+
5+
See [CONTRIBUTING.md](CONTRIBUTING.md) for build commands, testing, code style, and development workflow.
6+
7+
## Workspace Structure
8+
9+
See [README.md](README.md) for the workspace layout and [ARCH.md](ARCH.md) for some additional remark regarding important parts of LDK's architecture.
10+
11+
## Development Rules
12+
13+
- Always ensure tests pass before committing. To this end, you should run the test suite via `./ci/ci-tests.sh`.
14+
- Run `cargo +1.75.0 fmt --all` after every code change
15+
- Never add new dependencies unless explicitly requested
16+
- Please always disclose the use of any AI tools in commit messages and PR descriptions
17+
- When adding new `.rs` files, please ensure to always add the licensing header as found in all other files.

0 commit comments

Comments
 (0)