Add Copilot onboarding guide with build and layout essentials

[Copilot]

• Review repository structure, docs, and pipelines to gather onboarding details
• Validate build/test/lint commands and note toolchain requirements
• Draft .github/copilot-instructions.md with project summary, layout, and build guidance
• Run code review and security checks
• Final verification and summary
• Merge master changes into builder/contract.rs to resolve conflict
• Order builder imports consistently

Original prompt

Your task is to "onboard" this repository to Copilot coding agent by adding a .github/copilot-instructions.md file in the repository that contains information describing how a coding agent seeing it for the first time can work most efficiently.
The repository in question is a Rust-based project that works with the Ethereum Virtual Machine (EVM) and LLMs to compile and JIT compile EVM bytecode.
You will do this task only one time per repository and doing a good job can SIGNIFICANTLY improve the quality of the agent's work, so take your time, think carefully, and search thoroughly before writing the instructions.

• Reduce the likelihood of a coding agent pull request getting rejected by the user due to generating code that fails the continuous integration build, fails a validation pipeline, or having misbehavior.
• Minimize bash command and build failures (specifically regarding cargo and Rust toolchains).
• Allow the agent to complete its task more quickly by minimizing the need for exploration using grep, find, str_replace_editor, and code search tools.
  

* Instructions must be no longer than 2 pages. * Instructions must not be task specific. Add the following high level details about the codebase to reduce the amount of searching the agent has to do to understand the codebase each time: * A summary of what the repository does (specifically focusing on the JIT compilation and EVM interaction components). * High level repository information, such as the size of the repo, the Rust workspace structure (single crate vs multi-crate), and specific frameworks or libraries in use (e.g., revm, alloy, ethers, or specific LLM bindings). Add information about how to build and validate changes so the agent does not need to search and find it each time. * For each of bootstrap, build, test, run, lint (clippy, fmt), and any other scripted step, document the sequence of steps to take to run it successfully as well as the versions of any runtime or build tools used (e.g., specific Rust nightly/stable versions defined in rust-toolchain.toml). * Each command should be validated by running it to ensure that it works correctly as well as any preconditions and postconditions. * Try cleaning the repo (cargo clean) and running commands in different orders and document errors and misbehavior observed as well as any steps used to mitigate the problem. * Run the tests (cargo test) and document the order of steps required to run them, including any integration tests that might require a running node or EVM environment. * Make a change to the codebase. Document any unexpected build issues as well as the workarounds. * Document environment setup steps that seem optional but that you have validated are actually required (e.g., setting ETH_RPC_URL or API keys for LLMs). * Document the time required for commands that failed due to timing out. * When you find a sequence of commands that work for a particular purpose, document them in detail. * Use language to indicate when something should always be done. For example: "always run cargo fmt before pushing". * Record any validation steps from documentation. List key facts about the layout and architecture of the codebase to help the agent find where to make changes with minimal searching. * A description of the major architectural elements of the project, including the relative paths to the main project files (e.g., Cargo.toml), the location of configuration files for linting, compilation, testing, and preferences. * A description of the checks run prior to check in, including any GitHub workflows, continuous integration builds, or other validation pipelines. * Document the steps so that the agent can replicate these itself. * Any explicit validation steps that the agent can consider to have further confidence in its changes (e.g., running specific EVM compliance tests). * Dependencies that aren't obvious from the layout or file structure (e.g., external JIT libraries or system-level dependencies). * Finally, fill in any remaining space with detailed lists of the following, in order of priority: the list of files in the repo root, the contents of the README, the contents of any key source files (like main.rs or lib.rs), the list of files in the next level down of directories, giving priority to the more structurally important and snippets of code from key source files. * Perform a comprehensive inventory of the codebase. Search for and view: * README.md, CONTRIBUTING.md, and all other documentation files. * Search the codebase for build steps and indications of workarounds like 'HACK', 'TODO', etc. * All scripts, particularly those pertaining to build, cargo workflows, and environment setup. * All build and actions pipelines. * All project files (specifically C...

---

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

[semanticdiff-com]

Review changes with  

Changed Files

File	Status
crates/jet/src/builder/contract.rs	99% smaller
crates/jet_runtime/src/builtins.rs	50% smaller
crates/jet_runtime/src/binding/mod.rs	9% smaller
crates/jet/src/builder/ops.rs	8% smaller
crates/jet/src/builder/manager.rs	5% smaller
.github/copilot-instructions.md	Unsupported file format
crates/jet/src/bin/jetdbg.rs	0% smaller
crates/jet/src/builder/env.rs	0% smaller
crates/jet/src/engine/mod.rs	0% smaller
crates/jet/src/instructions.rs	0% smaller
crates/jet/src/lib.rs	0% smaller
crates/jet/tests/roms/mod.rs	0% smaller
crates/jet/tests/test_roms.rs	0% smaller
crates/jet_runtime/src/exec.rs	0% smaller
crates/jet_runtime/src/lib.rs	0% smaller
crates/jet_runtime/src/symbols.rs	0% smaller

[Copilot]

Pull request overview

This PR adds comprehensive onboarding documentation for GitHub Copilot agents to help them work more efficiently with the codebase. The documentation includes essential information about the repository's purpose (JIT compilation of EVM bytecode to LLVM IR), workspace structure, toolchain requirements, and validated build/test/lint commands. The PR also includes code formatting improvements across multiple Rust source files.

Changes:

• Added .github/copilot-instructions.md with detailed onboarding information for Copilot agents, including repository purpose, layout, toolchain dependencies, and validated build/test commands
• Applied rustfmt-style formatting improvements across 16 Rust source files (import reordering, trailing newline removal, and semicolon consistency fixes)

Reviewed changes

Copilot reviewed 16 out of 17 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
.github/copilot-instructions.md	New comprehensive onboarding guide for Copilot agents covering repo structure, build commands, and development workflow
crates/jet_runtime/src/symbols.rs	Removed trailing blank line
crates/jet_runtime/src/lib.rs	Removed trailing blank line
crates/jet_runtime/src/exec.rs	Reordered imports alphabetically and removed trailing blank line
crates/jet_runtime/src/builtins.rs	Reordered imports alphabetically and removed trailing blank line
crates/jet_runtime/src/binding/mod.rs	Reordered imports alphabetically and removed trailing blank line
crates/jet/tests/test_roms.rs	Removed trailing blank line
crates/jet/tests/roms/mod.rs	Removed trailing blank line
crates/jet/src/lib.rs	Removed trailing blank line
crates/jet/src/instructions.rs	Removed trailing blank line
crates/jet/src/engine/mod.rs	Reordered imports alphabetically and removed trailing blank line
crates/jet/src/builder/ops.rs	Reordered imports alphabetically and removed trailing blank line
crates/jet/src/builder/mod.rs	Removed trailing blank line
crates/jet/src/builder/manager.rs	Reordered imports alphabetically and removed trailing blank line
crates/jet/src/builder/env.rs	Removed trailing blank line
crates/jet/src/builder/contract.rs	Reordered imports alphabetically, improved formatting consistency (added semicolons, adjusted line breaks), and removed trailing blank line
crates/jet/src/bin/jetdbg.rs	Removed trailing blank line

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[tcrypt25519]

@copilot Fix the merge conflict with master in crates/jet/src/builder/contract.rs

[Copilot]

@copilot Fix the merge conflict with master in crates/jet/src/builder/contract.rs

Resolved by bringing builder/contract.rs in line with master (includes InvalidOpcode import and find_code_blocks error propagation). Commit 3a0a524.

Pull request overview

This PR adds comprehensive onboarding documentation for GitHub Copilot agents to help them work more efficiently with the codebase. The documentation includes essential infor...

Addressed by aligning import ordering and keeping InvalidOpcode from master; latest commit 3a0a524 includes the resolved merge, and imports are now tidy.