Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Sep 25, 2025

This PR adds comprehensive instruction files for different AI assistants (Claude, Gemini, GitHub Copilot, and others) working on the Onchain Test Kit project. These files provide tailored guidance that leverages each AI assistant's unique strengths while maintaining consistency in technical standards and development practices.

Overview

The instruction files help AI assistants understand the project's architecture, coding patterns, testing requirements, and development workflow. Each file is specifically tailored to different AI assistants' capabilities while maintaining consistent technical guidance about the Onchain Test Kit's builder patterns, wallet automation, and Playwright integration.

Files Added

Root Level Instructions

  • AGENTS.md - Universal guidance for all AI assistants with comprehensive project overview, architecture details, and development best practices
  • CLAUDE.md - Claude-specific instructions emphasizing analytical approach, systematic problem-solving, and thorough code analysis
  • GEMINI.md - Gemini-focused instructions leveraging multimodal capabilities, creative problem-solving, and holistic system understanding

Directory Structure

  • .github/instructions/ - New directory containing assistant-specific instruction files:
    • claude.instructions.md - Concise Claude development guidelines
    • gemini.instructions.md - Focused Gemini development instructions
    • general.instructions.md - Universal AI assistant guidelines
    • README.md - Directory documentation

Key Features

Consistent Technical Foundation

All instruction files maintain consistency with the existing .github/copilot-instructions.md and reference the same:

  • TypeScript and Playwright patterns
  • Builder pattern for configuration APIs
  • Wallet automation architecture
  • Testing strategies and fork mode functionality

Assistant-Specific Guidance

  • Claude: Emphasizes systematic analysis, architectural understanding, and comprehensive testing
  • Gemini: Leverages multimodal processing, pattern recognition, and creative problem-solving
  • General: Provides universal guidelines applicable to any AI assistant

Practical Examples

Each file includes relevant code examples demonstrating:

// Configuration pattern
const config = configure()
  .withMetaMask()
  .withSeedPhrase({ seedPhrase: '...', password: '...' })
  .withNetwork({ name: '...', rpcUrl: '...', chainId: 1 })
  .build();

// Testing pattern
test('wallet interaction', async ({ page, metamask }) => {
  await metamask.handleAction('connect', { shouldApprove: true });
});

Benefits

  1. Improved Code Quality: AI assistants will better understand project conventions and architectural patterns
  2. Consistent Development: All assistants follow the same technical standards while leveraging their unique strengths
  3. Better Testing: Clear guidance on testing requirements, including edge cases and error handling
  4. Enhanced Documentation: Instructions emphasize keeping documentation up-to-date with code changes
  5. Future Maintenance: Structured approach for adding support for new AI assistants

No Breaking Changes

This PR only adds documentation files and does not modify any existing functionality:

  • All existing tests pass
  • Project builds successfully
  • No changes to public APIs
  • No impact on runtime behavior

The instruction files will help AI assistants contribute more effectively to the Onchain Test Kit while maintaining the high standards of reliability and type safety that make this toolkit valuable for blockchain application testing.

Original prompt

/.github/copilot-instructions.md
/.github/instructions/**/*.instructions.md
**/AGENTS.md
/CLAUDE.md
/GEMINI.mdhttps://api.githubcopilot.com/mcp/readonly @copilot


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

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.

Co-authored-by: joe10832 <103850533+joe10832@users.noreply.github.com>
Copilot AI changed the title [WIP] /.github/copilot-instructions.md /.github/instructions/**/*.instructions.md **/AGENTS.md /CLAUDE.md /GEMINI.mdhttps://api.githubcopilot.com/mcp/readonly @copilot Add comprehensive AI assistant instruction files for development guidance Sep 25, 2025
Copilot AI requested a review from joe10832 September 25, 2025 07:42
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.

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.

@joe10832 joe10832 marked this pull request as ready for review September 25, 2025 13:33
Copilot AI review requested due to automatic review settings September 25, 2025 13:33
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.

Pull Request Overview

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

Comments suppressed due to low confidence (1)

GEMINI.md:1

  • Inconsistent capitalization. Should be 'For Testing Agents' to match the pattern used in other headings like 'For Code Generation Agents' and 'For Code Analysis Agents'.
# Gemini Instructions for Onchain Test Kit

Co-authored-by: Copilot <175728472+Copilot@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.

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.

@joe10832 joe10832 self-requested a review October 3, 2025 22:44
@joe10832
Copy link
Member

joe10832 commented Oct 3, 2025

Pull Request Overview

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

Comments suppressed due to low confidence (1)

GEMINI.md:1

  • Inconsistent capitalization. Should be 'For Testing Agents' to match the pattern used in other headings like 'For Code Generation Agents' and 'For Code Analysis Agents'.
# Gemini Instructions for Onchain Test Kit

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.

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.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

✨ Set up Copilot instructions

2 participants