Add context guide, skill files and dev scripts#1132
Open
anvacaru wants to merge 6 commits into
Open
Conversation
juliankuners
requested changes
Apr 25, 2026
| | ------------------ | ------------------------------------------------------------------------------------------------------------------------- | | ||
| | `build-kontrol` | Full build: K version check/install, `uv sync`, `kdist clean+build`. | | ||
| | `selector "<sig>"` | Compute the ABI function selector for `<sig>` as a decimal integer (uses `cast sig`). | | ||
| | `update-expected-output [--foundry] [--cse] [--end-to-end] [-k <filter>]` | Wrapper script over the make recipes to egenerate expected-output snapshots. Pass a suite flag to target one suite; `-k` scopes to a single test. Runs all suites if no flag given. | |
Contributor
There was a problem hiding this comment.
typo: egenerate -> generate
Suggested change
| | `update-expected-output [--foundry] [--cse] [--end-to-end] [-k <filter>]` | Wrapper script over the make recipes to egenerate expected-output snapshots. Pass a suite flag to target one suite; `-k` scopes to a single test. Runs all suites if no flag given. | | |
| | `update-expected-output [--foundry] [--cse] [--end-to-end] [-k <filter>]` | Wrapper script over the make recipes to generate expected-output snapshots. Pass a suite flag to target one suite; `-k` scopes to a single test. Runs all suites if no flag given. | |
|
|
||
| # 2. After any Python change: format then run all checkers + unit tests | ||
| make format # auto-format (autoflake + isort + black) | ||
| make # check (flake8, mypy, autoflake, isort, black) + unit tests |
Contributor
There was a problem hiding this comment.
make this test make check explicitely. While make will run make check, test-unit is explicitely called in Step 3 as well, so please adapt either for consistency.
Suggested change
| make # check (flake8, mypy, autoflake, isort, black) + unit tests | |
| make check # check (flake8, mypy, autoflake, isort, black) + unit tests |
Comment on lines
+16
to
+19
| install_k() { | ||
| echo "Installing or updating K to version $REQUIRED_VERSION..." | ||
| kup install k.openssl.secp256k1 --version "$REQUIRED_VERSION" | ||
| } |
Contributor
There was a problem hiding this comment.
Can't we instead make use of the available nix develop shell? This way, the kup installed version of K is not changed.
See e.g.:
nix develop --command uv run kdist
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
2 participants
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.
Adds Claude Code support for the Kontrol repo: a context guide for navigating the codebase, three workflow skills, and two developer scripts.
CLAUDE.md/AGENTS.md: guide covering project structure, K semantic definitions, CLI commands, cheatcode inventory (Foundry and Kontrol-proprietary), testing conventions, dev workflow, and gotchas.
Skills
/build- runsscripts/build-kontrol, captures output, surfaces K compiler errors on failure/add-cheatcode- step-by-step guide for adding a new cheatcode (K rule, selector, Solidity test, CI registration)/update-expected-output— runs golden file regeneration for foundry / CSE+minimize / end-to-end suites; recommends scoping with--foundry/--cse/--end-to-endand-k test_nameScripts
scripts/build-kontrol— K version check/install,uv sync,kdist clean+buildscripts/selector— computes ABI function selector as decimal integer (wrapscast sig)scripts/update-expected-output— pytest.expectedfile regeneration with per-suite flags and parallel worker tuning