Skip to content

Add CLAUDE.md with guidance for AI coding agents - #739

Merged
wasabii merged 3 commits into
mainfrom
docs/claude-md
Aug 15, 2026
Merged

wasabii merged 3 commits into
mainfrom
docs/claude-md

Conversation

@wasabii

@wasabii wasabii commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Adds a CLAUDE.md at the repo root for AI coding agents working in this tree.

The first section is the attribution rule: no AI tool named in commit messages, PR titles, or PR bodies — no Co-Authored-By trailers, no "generated with" footers, no badges. Using tools needs no disclosure; whoever submits the work is responsible for it either way, so there is nothing for the tool to take credit or blame for.

The rest is a short set of build and test facts that are easy to get wrong and aren't covered by CONTRIBUTING.md, which the file links to rather than duplicates:

  • Narrowing EnabledRuntimes and friends to avoid building the macOS and Linux cross targets on a Windows host.
  • Running IKVM.Tests needs a complete IKVM home, so compiling IKVM.Runtime and IKVM.Java alone isn't sufficient.
  • Parallel MSBuild puts a failing project's errors in the middle of the log, not the tail — search for : error , or use the uploaded msbuild.binlog.
  • How a native method binds to its IKVM.Java.Externs.<package>.<Class> counterpart, and that an unmatched native produces a stub that throws at runtime rather than failing the build — so a clean ikvmc run is not evidence a new native bound.
  • Where flaky jtreg exclusions live and how their platform scopes work.

Documents the rule that AI tools must not be named in commit messages or pull
request bodies, and captures a few build and test facts that are easy to get
wrong: narrowing the runtime set to avoid cross-platform native builds, the fact
that running IKVM.Tests needs a complete IKVM home, that parallel build errors
appear mid-log rather than at the tail, how native methods bind to Externs types
and why a clean build does not prove a binding resolved, and where flaky jtreg
exclusions live.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant