Add comprehensive GitHub Copilot and AI agent setup documentation #80

Copilot · 2025-09-27T20:59:41Z

This PR addresses the missing comprehensive setup steps and usage instructions for GitHub Copilot and AI agent integrations, making it easier for new contributors to get started with AI-powered development in the Onchain Test Kit project.

Problem

The repository lacked consolidated documentation for:

Setting up and configuring GitHub Copilot
Understanding the structure and purpose of .github/instructions/**/*.instructions.md files
Configuring and using AI agents (Claude, Gemini) effectively
Example workflows and troubleshooting guidance

This made it difficult for new contributors to understand how to leverage the AI tooling available in the project.

Solution

Enhanced `.github/copilot-instructions.md`

Quick Start Setup: Added step-by-step setup guide covering repository setup, Copilot configuration, agent setup, and environment configuration
Documentation Structure: Comprehensive explanation of how different instruction files work together
Example Workflows: Three detailed workflows showing how to add wallet actions, implement fork mode support, and debug wallet issues
Table of Contents: Added navigation structure for easy access to different sections

Improved Agent Documentation

AGENTS.md: Added agent setup checklist, workflow examples, and enhanced troubleshooting with agent-specific best practices
CLAUDE.md: Added Claude-optimized setup workflow with analytical problem-solving patterns and comprehensive implementation examples
GEMINI.md: Added rapid setup steps and performance-focused examples showcasing Gemini's strengths in quick prototyping

Updated README.md

Added dedicated "AI Agent and Copilot Setup" section with clear documentation structure navigation and quick start guide for AI agents.

Key Features Added

Setup Guidance: Complete step-by-step instructions from repository clone to working AI-assisted development environment.

Agent Workflows: Concrete TypeScript examples for common tasks:

// Example: Adding a new wallet action
async handleAction(action: WalletActionType, options: ActionOptions): Promise<void> {
  switch (action) {
    case 'signMessage':
      return this.handleSignMessage(options);
    // ... other cases
  }
}

Troubleshooting: Comprehensive solutions for common issues like "Extension not found", "Network timeout", and agent-specific problems.

Documentation Structure: Clear explanation of how .github/copilot-instructions.md, AGENTS.md, CLAUDE.md, GEMINI.md, and specialized instruction files work together.

Impact

Faster Onboarding: New contributors can now set up AI assistance in minutes instead of hours
Better AI Assistance: Clear context helps agents provide more relevant suggestions
Consistent Patterns: Standardized workflows ensure consistent code quality across contributors
Reduced Friction: Comprehensive troubleshooting reduces setup barriers

The documentation now provides everything needed for effective AI-assisted development in the Onchain Test Kit ecosystem, addressing the gap identified in the original issue.

Original prompt

This section details on the original issue you should resolve

<issue_title>copilot-setup-steps</issue_title>
<issue_description>## Documentation Issue Type

Error in existing documentation

Missing documentation

Unclear or confusing documentation

Example code not working

Request for additional examples

Location

Where is the documentation issue located?

README.md

API documentation (JSDoc comments)

Examples in /example directory

Documentation in /docs directory

GitHub Copilot instructions (.github/copilot-instructions.md)

Copilot Agent instructions (.github/instructions/**/*.instructions.md)

Agents documentation (**/AGENTS.md)

Claude agent documentation (/CLAUDE.md)

Gemini agent documentation (/GEMINI.md)

Contributing guide

Other: ____________

Current Documentation

Currently, there is no clear, consolidated documentation for Copilot and agent setup steps in the specified files:

.github/copilot-instructions.md

.github/instructions/**/*.instructions.md

**/AGENTS.md

/CLAUDE.md

/GEMINI.md

Issue Description

There is a lack of comprehensive setup steps and usage instructions for GitHub Copilot and agent integrations. This makes it difficult for new contributors or users to understand how to configure, use, and extend Copilot and the supported agents.

Suggested Improvement

Add step-by-step documentation covering:

How to set up and configure GitHub Copilot in this repository

Structure and purpose of .github/instructions/**/*.instructions.md files

Agent setup and configuration (AGENTS.md, CLAUDE.md, GEMINI.md)

Example flows for using agents

Best practices for extending or customizing Copilot instructions

Troubleshooting common issues

Use Case

This would help new contributors and users:

Get started quickly with Copilot and agent integrations

Understand the available agents and their configuration

Extend or customize instructions as needed

Additional Context

This request was derived from reviewing the repository and the presence/absence of clear documentation in the above files.

Example reference: [tests/config/builder.test.ts] contains examples of good structure for test coverage—similar clarity is needed for documentation.

Code Example (if applicable)

N/A

Environment (if reporting broken examples)

Onchain Test Kit Version:

Node.js Version:

Operating System:

Checklist

I have searched for existing documentation issues

I have checked if this is covered in other sections

I have provided specific suggestions for improvement

I have included relevant code examples (if applicable)
</issue_description>

<agent_instructions>Copilot-Setup-Steps <issue_title>copilot-setup-steps</issue_title>
<issue_description>/.github/copilot-instructions.md
/.github/instructions/**/*.instructions.md
**/AGENTS.md
/CLAUDE.md
/GEMINI.md</issue_description> @copilot-instructions.md </agent_instructions>

Comments on the Issue (you are @copilot in this section)

Fixes #79

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Co-authored-by: joe10832 <[email protected]>

joe10832 · 2025-09-27T21:16:27Z

@copilot

joe10832

@copilot

Copilot

Pull Request Overview

This PR addresses the missing comprehensive setup documentation for GitHub Copilot and AI agent integrations in the Onchain Test Kit project, providing clear step-by-step instructions and workflow examples to help new contributors get started with AI-powered development.

Key changes include:

Added complete GitHub Copilot setup guide with quick start steps, configuration instructions, and troubleshooting
Enhanced agent-specific documentation (CLAUDE.md, GEMINI.md, AGENTS.md) with setup workflows and optimization examples
Integrated comprehensive AI agent documentation section into README.md with clear navigation structure

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
.github/copilot-instructions.md	Added comprehensive setup guide, table of contents, agent workflow examples, and troubleshooting section
AGENTS.md	Enhanced with quick setup checklist, workflow examples, and agent-specific best practices
CLAUDE.md	Added Claude-optimized setup workflow with analytical implementation examples
GEMINI.md	Added rapid setup steps and performance-focused optimization examples
README.md	Integrated new AI agent documentation section with clear navigation and quick start guide

Copilot · 2025-09-27T22:18:27Z

.github/copilot-instructions.md

+### Step 1: Repository Setup
+1. **Clone the repository**:
+   ```bash
+   git clone https://github.com/coinbase/onchaintestkit.git


+### Step 2: GitHub Copilot Configuration
+1. Enable Copilot in your IDE (VS Code, IntelliJ, etc.)
+2. Load project context: Open the repository in your IDE to let Copilot understand the codebase
+3. Review instructions: Familiarize yourself with this file and the specialized instruction files in .github/instructions/
+
+### Step 3: AI Agent Setup (Optional)
+For advanced AI assistance, review the agent-specific documentation:
+- Claude: See CLAUDE.md for Claude-specific instructions and focus areas
+- Gemini: See GEMINI.md for Gemini-specific strengths and workflows
+- General: See AGENTS.md for common AI agent guidelines
+
+### Step 4: Environment Configuration
+1. Set required environment variables:

Create .env file (never commit this)

echo "E2E_TEST_SEED_PHRASE=your-test-seed-phrase-here" > .env> copilot The repository URL appears to be hardcoded to 'coinbase/onchaintestkit'. According to the project documentation structure described in the coding guidelines, this should use a placeholder like <repository-url> to match the pattern shown in the setup instructions, or should reference the actual repository if this is accurate.

+3. Build and Development Commands
+4. Architecture & Project Layout
+5. Configuration Patterns
+6. Development Guidelines
+7. Environment Setup
+8. Common Patterns & Examples
+9. Troubleshooting
+10. Understanding Agent Instructions Structure
+11. Example Workflows for AI Agents

+## Quick Start Setup for GitHub Copilot
+
+### Step 1: Repository Setup
+1. Clone the repository:

@copilot The repository URL appears to be hardcoded to 'coinbase/onchaintestkit'. According to the project documentation structure described in the coding guidelines, this should use a placeholder like <repository-url> to match the pattern shown in the setup instructions, or should reference the actual repository if this is accurate.

https://github.com/MunyayLLC/https-github.com-joe10832-onchaintestkit/actions/runs/18069045265/job/51416351598#step:5:55https://github.com/your-username/onchaintestkit.git

git clone
cd onchaintestkit

.github/copilot-instructions.md

GEMINI.md

joe10832

@joe10832 @copilot

joe10832 · 2025-09-28T04:00:11Z

@copilot

Co-authored-by: Copilot <[email protected]>

joe10832

@copilot

joe10832

@copilot @joe10832

joe10832

@copilot

joe10832 · 2025-09-28T04:36:36Z

@copilot

Co-authored-by: Copilot <[email protected]>

joe10832

@copilot

joe10832

@copilot

joe10832

@joe10832 @copilot

Initial plan

22478f2

Copilot AI assigned Copilot and joe10832 Sep 27, 2025

Copilot started work on behalf of joe10832 September 27, 2025 20:59 View session

Add comprehensive Copilot and AI agent setup documentation

b0e1689

Co-authored-by: joe10832 <[email protected]>

Copilot AI changed the title ~~[WIP] copilot-setup-steps~~ Add comprehensive GitHub Copilot and AI agent setup documentation Sep 27, 2025

Copilot finished work on behalf of joe10832 September 27, 2025 21:10

Copilot AI requested a review from joe10832 September 27, 2025 21:10

Copilot started work on behalf of joe10832 September 27, 2025 21:16 View session

Copilot finished work on behalf of joe10832 September 27, 2025 21:18

joe10832 approved these changes Sep 27, 2025

View reviewed changes

joe10832 marked this pull request as ready for review September 27, 2025 22:17

Copilot AI review requested due to automatic review settings September 27, 2025 22:17

Copilot AI reviewed Sep 27, 2025

View reviewed changes

joe10832 removed their assignment Sep 27, 2025

Copilot started work on behalf of joe10832 September 28, 2025 02:14 View session

Copilot finished work on behalf of joe10832 September 28, 2025 02:16

Copilot AI requested a review from joe10832 September 28, 2025 02:16

Copilot AI mentioned this pull request Sep 28, 2025

Fix hardcoded repository URL in CONTRIBUTING.md to use consistent placeholder pattern #89

Merged

joe10832 approved these changes Sep 28, 2025

View reviewed changes

Copilot started work on behalf of joe10832 September 28, 2025 04:00 View session

Update .github/copilot-instructions.md

1f66346

Co-authored-by: Copilot <[email protected]>

Copilot finished work on behalf of joe10832 September 28, 2025 04:02

Copilot AI requested a review from joe10832 September 28, 2025 04:02

joe10832 reviewed Sep 28, 2025

View reviewed changes

Copilot started work on behalf of joe10832 September 28, 2025 04:05 View session

Copilot AI requested a review from joe10832 September 28, 2025 04:07

Copilot finished work on behalf of joe10832 September 28, 2025 04:07

joe10832 approved these changes Sep 28, 2025

View reviewed changes

joe10832 self-requested a review September 28, 2025 04:20

joe10832 reviewed Sep 28, 2025

View reviewed changes

Copilot started work on behalf of joe10832 September 28, 2025 04:36 View session

Copilot AI requested a review from joe10832 September 28, 2025 04:38

Copilot finished work on behalf of joe10832 September 28, 2025 04:38

Copilot started work on behalf of joe10832 September 28, 2025 04:38 View session

Copilot finished work on behalf of joe10832 September 28, 2025 04:40

Copilot started work on behalf of joe10832 September 28, 2025 04:43 View session

Copilot finished work on behalf of joe10832 September 28, 2025 04:45

Copilot started work on behalf of joe10832 September 28, 2025 04:45 View session

Copilot finished work on behalf of joe10832 September 28, 2025 04:47

Copilot started work on behalf of joe10832 September 28, 2025 04:47 View session

Copilot finished work on behalf of joe10832 September 28, 2025 04:49

joe10832 and others added 2 commits September 28, 2025 00:50

Update GEMINI.md

929fcf6

Co-authored-by: Copilot <[email protected]>

Update GEMINI.md

4995ef0

joe10832 approved these changes Sep 28, 2025

View reviewed changes

joe10832 approved these changes Sep 29, 2025

View reviewed changes

joe10832 linked an issue Oct 3, 2025 that may be closed by this pull request

✨ Set up Copilot instructions #176

Closed

joe10832 approved these changes Oct 13, 2025

View reviewed changes

Uh oh!

Add comprehensive GitHub Copilot and AI agent setup documentation #80

Are you sure you want to change the base?

Add comprehensive GitHub Copilot and AI agent setup documentation #80

Uh oh!

Conversation

Copilot AI commented Sep 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Problem

Solution

Enhanced .github/copilot-instructions.md

Improved Agent Documentation

Updated README.md

Key Features Added

Impact

Location

Current Documentation

Issue Description

Suggested Improvement

Use Case

Additional Context

Code Example (if applicable)

Environment (if reporting broken examples)

Checklist

Comments on the Issue (you are @copilot in this section)

Uh oh!

joe10832 commented Sep 27, 2025

Uh oh!

joe10832 left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Sep 27, 2025 • edited by joe10832 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Create .env file (never commit this)

Uh oh!

joe10832 Sep 28, 2025

Choose a reason for hiding this comment

Uh oh!

joe10832 Sep 28, 2025

Choose a reason for hiding this comment

Uh oh!

joe10832 Sep 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

joe10832 left a comment

Choose a reason for hiding this comment

Uh oh!

joe10832 commented Sep 28, 2025

Uh oh!

joe10832 left a comment

Choose a reason for hiding this comment

Uh oh!

joe10832 left a comment

Choose a reason for hiding this comment

Uh oh!

joe10832 left a comment

Choose a reason for hiding this comment

Uh oh!

joe10832 commented Sep 28, 2025

Uh oh!

joe10832 left a comment

Choose a reason for hiding this comment

Uh oh!

joe10832 left a comment

Choose a reason for hiding this comment

Uh oh!

joe10832 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Copilot AI commented Sep 27, 2025 •

edited

Loading

Enhanced `.github/copilot-instructions.md`

Copilot AI Sep 27, 2025 •

edited by joe10832

Loading