Add GitHub Copilot instructions for o1js development workflow #2387
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.
This PR adds comprehensive GitHub Copilot instructions to help coding agents work effectively in the o1js codebase. The instructions provide detailed guidance on building, testing, and developing with o1js while working around its complex build requirements.
Key Features
Build Process Guidance:
Validated Commands with Timing:
npm install(18 seconds)git submodule update --init --recursivewith LFS skip (5 minutes)npm run lint(2 seconds, shows expected warnings)src/mina-signerbuild and test workflow (37 seconds total)Critical Build Limitations:
The instructions clearly document that o1js requires pre-compiled OCaml/Rust bindings from CI builds, which external contributors cannot generate without GitHub authentication. This is a core architectural constraint that affects the development workflow.
Working Validation Scenarios:
Comprehensive Troubleshooting:
The instructions follow an imperative tone ("Run this command", "Set timeout to X") and provide exhaustive detail to ensure agents can copy-paste commands that work reliably every time.
Fixes #2386.
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
esm.ubuntu.com/usr/lib/apt/methods/https(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.