Repository navigation
Add CLAUDE.md - #4
Open
devinrsmith wants to merge 1 commit into
Open
devinrsmith wants to merge 1 commit into
devinrsmith wants to merge 1 commit into
Conversation
Guidance for Claude Code sessions in this repository: what the library is and where its contract lives, that Gradle must run inside the devenv shell, the build/test/format commands (including the per-JDK test tasks), and the architecture notes that aren't obvious from a single file -- the multi-release JAR layout and shim pairs, how the java17/21/25Test tasks reuse the java11 override, the version-catalog convention, the devenv toolchain wiring, the SeqLock state encoding and asserts, and the RequestStatsExample/README pairing.
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The documented workflow and concurrency guarantees need the noted clarifications.
Get a fresh assessment by requesting another Copilot review.
Review effort: Balanced
Findings: 2
Open (2)
What changed in this PR
Adds repository guidance for development workflows, architecture, testing, formatting, and SeqLock conventions.
Changes:
- Documents Gradle/devenv workflows and JDK-specific tests.
- Explains the multi-release JAR, shims, toolchains, and examples.
- Records
SeqLockstate and concurrency expectations.
| File | Review |
|---|---|
CLAUDE.md |
Clarify that single-writer use is a caller obligation, devenv is recommended rather than required, and build runs rather than applies Spotless checks. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| ## Dev shell | ||
|
|
||
| This repo's dev environment is managed by `devenv.nix`/`devenv.yaml` (via `nix-gradle-wrapper`, a | ||
| non-flake input pinned in `devenv.lock`). Running Gradle inside it is recommended, not required: |
Comment on lines
+84
to
+87
| - `SeqLock` state: a `volatile long sequence` (reader-visible) plus a writer-private plain `long | ||
| writerSeq`. Even sequence = quiescent/readable; odd = write-in-progress. `assert` statements in | ||
| `beginWrite`/`endWrite` enforce single-writer, non-reentrant use (run with `-ea` to have these | ||
| checked; the test suite relies on them via `SeqLockTest.doubleBeginWrite`/`doubleEndWrite`). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Guidance for Claude Code sessions in this repository: what the library is and where its contract lives, that Gradle must run inside the devenv shell, the build/test/format commands (including the per-JDK test tasks), and the architecture notes that aren't obvious from a single file -- the multi-release JAR layout and shim pairs, how the java17/21/25Test tasks reuse the java11 override, the version-catalog convention, the devenv toolchain wiring, the SeqLock state encoding and asserts, and the RequestStatsExample/README pairing.