Add basic CLAUDE.md file
#4352
Add basic CLAUDE.md file
#4352
Conversation
|
👋 Thanks for assigning @joostjager as a reviewer! |
|
@joostjager @TheBlueMatt Anything else that you deem worthy to add? |
tnull
force-pushed
the
2026-01-add-claude-md
branch
from
018b48c to
cd6ac32
Compare
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>
tnull
force-pushed
the
2026-01-add-claude-md
branch
from
cd6ac32 to
ecf8c05
Compare
TheBlueMatt
left a comment
TheBlueMatt
left a comment
There was a problem hiding this comment.
Nothing comes to mind, we can definitely iterate on it.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4352 +/- ##
=======================================
Coverage 86.08% 86.09%
=======================================
Files 156 156
Lines 102428 102428
Branches 102428 102428
=======================================
+ Hits 88179 88181 +2
+ Misses 11754 11753 -1
+ Partials 2495 2494 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
|
||
| ## Development Rules | ||
|
|
||
| - Always ensure tests pass before committing. To this end, you should run the test suite via `./ci/ci-tests.sh`. |
There was a problem hiding this comment.
I don't think this is always practical when working on draft branches?
There was a problem hiding this comment.
probably it is possible to specify it in a way that we can ask claude to run the CI checks? But do not assume to run it always?
On mine I have
### When to run CI checks
- When explicitly asked (e.g., "run CI", "check CI", "verify commits")
- Before creating a PR (if requested)
- After fixing CI-related issues
There was a problem hiding this comment.
I don't think this is always practical when working on draft branches?
Hmm, but ensuring tests pass before committing is kinda important, no? And in my experience it will allow Claude to catch a lot of bugs? Any suggestion for a good replacement, maybe cargo test, which should be considerably faster, even if it doesn't catch everything?
| - Always ensure tests pass before committing. To this end, you should run the test suite via `./ci/ci-tests.sh`. | ||
| - Run `cargo +1.75.0 fmt --all` after every code change | ||
| - Never add new dependencies unless explicitly requested | ||
| - Please always disclose the use of any AI tools in commit messages and PR descriptions |
There was a problem hiding this comment.
Specify how this should be disclosed, maybe a standard sentence to add for consistency?
There was a problem hiding this comment.
We should consistently require it disclose itself as HAL 9000 😂
| - Run `cargo +1.75.0 fmt --all` after every code change | ||
| - Never add new dependencies unless explicitly requested | ||
| - Please always disclose the use of any AI tools in commit messages and PR descriptions | ||
| - When adding new `.rs` files, please ensure to always add the licensing header as found in all other files. |
There was a problem hiding this comment.
We could make it easy and link one file here, so that AI doesn't need to look at all other files?
| ## Development Rules | ||
|
|
||
| - Always ensure tests pass before committing. To this end, you should run the test suite via `./ci/ci-tests.sh`. | ||
| - Run `cargo +1.75.0 fmt --all` after every code change |
There was a problem hiding this comment.
I already had this myself, and it is nice that it does this.
5 participants
We add a basic
CLAUDE.mdfile pointing it to some workspace specifics (in particular runningcargo fmton 1.75.0 MSRV, and using./ci/ci-tests.shto run tests).