Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Sep 24, 2025

This PR adds a comprehensive .github/copilot-instructions.md file that provides GitHub Copilot coding agents with detailed instructions for working effectively in the Onchain Test Kit codebase.

What's included

The instructions file provides:

Validated Build and Development Workflow:

  • Complete setup instructions with npm install and npm run build
  • All npm scripts documented with actual measured timing (~1.5s for builds, ~0.2s for linting)
  • Proper timeout specifications with "NEVER CANCEL" warnings for build operations

Comprehensive Validation Scenarios:

  • Basic configuration testing: node example/test-config.js
  • Fork mode validation: node example/fork-mode-example.js
  • Multi-wallet configuration testing (MetaMask, Coinbase, Phantom)
  • Complete API functionality validation

Architecture Documentation:

  • Detailed source code structure with file-by-file explanations
  • Key dependencies and their purposes (Playwright, Biome, TypeScript)
  • Fluent builder pattern usage: configure().withMetaMask().withNetwork().build()
  • Fork mode capabilities and limitations (requires Foundry/Anvil)

Practical Development Guidance:

  • Step-by-step workflows for common tasks
  • How to add new wallet support
  • When to run specific validation commands
  • Troubleshooting common issues

Validation

Every command and process mentioned in the instructions has been thoroughly tested:

  • ✅ All build commands execute successfully with measured timings
  • ✅ All example configurations run without errors
  • ✅ Complete manual validation scenario passes
  • ✅ API functionality confirmed working
  • ✅ Directory structures and file locations verified

The instructions are designed to help GitHub Copilot agents understand the codebase architecture, run the correct validation steps, and work efficiently without trial-and-error on build processes or testing approaches.

Fixes #8.

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:

  • foundry.paradigm.xyz
    • Triggering command: curl -L REDACTED (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.

Co-authored-by: joe10832 <103850533+joe10832@users.noreply.github.com>
Copy link
Member

@joe10832 joe10832 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/.github/copilot-instructions.md
/.github/instructions/**/*.instructions.md
**/AGENTS.md
/CLAUDE.md @copilot
/GEMINI.md

@joe10832 joe10832 marked this pull request as ready for review September 24, 2025 06:46
Copilot AI review requested due to automatic review settings September 24, 2025 06:46
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot wasn't able to review any files in this pull request.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@joe10832 joe10832 merged commit 22deff9 into main Sep 24, 2025
2 checks passed
@joe10832 joe10832 requested a review from Copilot September 24, 2025 06:49
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot wasn't able to review any files in this pull request.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Copilot AI changed the title [WIP] ✨ Set up Copilot instructions Add comprehensive GitHub Copilot instructions for onchain test kit development Sep 24, 2025
Copilot AI requested a review from joe10832 September 24, 2025 06:50
@joe10832 joe10832 requested review from Copilot and removed request for joe10832 September 24, 2025 07:01
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot wasn't able to review any files in this pull request.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

2 participants