Skip to content

Commit 8fff72e

Browse files
authored
Merge pull request #4305 from graphql-java/claude/create-claude-md-M7lji
Update agents.md to improve AI assisted PRs
2 parents 30797cf + 135848b commit 8fff72e

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,5 @@ docs/_build/
1717
/.nb-gradle/
1818
gen
1919
.DS_Store
20-
.vscode
20+
.vscode
21+
.claude/scheduled_tasks.lock

AGENTS.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
# AI Agent Context for graphql-java
22

3-
This file provides context for AI assistants working with this codebase.
3+
## Rules
4+
5+
- **Tests in Spock (Groovy)**, not JUnit: `src/test/groovy/graphql/`
6+
- **No new dependencies** (firm policy)
7+
- **No wildcard imports**, no inner classes, no `Optional`
8+
- Max 2 indent levels; early returns; extract methods to reduce nesting
9+
- Immutable data classes w/ Builder: `newFoo()` factory, `foo(value)` setters, `transform()` method
10+
- Use `graphql.Assert` not `Objects.requireNonNull`
11+
- Use `@Public`/`@Internal` annotations — never package-private/protected
12+
- `@NullMarked` on all public API classes; `@NullUnmarked` on their Builder classes; use `@Nullable` for nullable params/returns; NullAway enforced via ErrorProne
13+
- Full style guide: `coding-guidelines.md`
414

515
## Test Execution
616

0 commit comments

Comments
 (0)