Skip to content

✨copilot-setup-steps Configure comprehensive AI coding agent instructions for repository#46

Merged
joe10832 merged 2 commits intomainfrom
copilot/fix-449bb556-8d8c-490a-992f-67ab2a7cd68d
Sep 25, 2025
Merged

✨copilot-setup-steps Configure comprehensive AI coding agent instructions for repository#46
joe10832 merged 2 commits intomainfrom
copilot/fix-449bb556-8d8c-490a-992f-67ab2a7cd68d

Conversation

Copy link
Contributor

Copilot AI commented Sep 25, 2025

This PR implements comprehensive GitHub Copilot setup and AI coding agent instructions for the Onchain Test Kit repository, following the best practices for AI-assisted development workflows.

What's Changed

Added specialized instruction files for different AI coding agents to provide contextual guidance when working on the Onchain Test Kit project:

  • AGENTS.md - General AI coding agent instructions covering project overview, architecture principles, and common development tasks
  • CLAUDE.md - Claude-specific instructions optimized for analytical problem solving and comprehensive blockchain testing scenarios
  • GEMINI.md - Gemini-specific instructions focused on rapid prototyping, developer experience, and performance optimization
  • .github/instructions/development.instructions.md - Detailed development environment setup, code quality standards, and workflow guidelines
  • .github/instructions/testing.instructions.md - Comprehensive testing strategies including fork mode, wallet automation, and cross-wallet compatibility patterns
  • .github/instructions/wallet-integration.instructions.md - Specialized guidance for wallet implementations, covering MetaMask, Coinbase Wallet, and Phantom integrations

Key Features

Blockchain Testing Expertise: Each instruction file provides detailed guidance on the unique aspects of blockchain DApp testing, including:

  • Fork mode configuration for testing against real blockchain data
  • Wallet automation patterns for MetaMask, Coinbase, and Phantom
  • Network switching and multi-chain testing scenarios
  • DeFi protocol integration testing strategies

TypeScript & Playwright Best Practices: All instructions emphasize the project's core technologies:

  • Strict TypeScript configuration and typing patterns
  • Playwright fixture patterns for wallet automation
  • Configuration builder patterns using fluent APIs
  • Async/await patterns for blockchain operations

Agent-Specific Optimizations:

  • Claude: Leverages analytical strengths for complex blockchain scenarios and comprehensive error handling
  • Gemini: Focuses on rapid prototyping, clean APIs, and performance optimization
  • General: Provides foundational knowledge applicable to all AI agents

Content Structure

Each instruction file maintains consistency while providing specialized guidance:

  • Project architecture and core technologies overview
  • Development workflows and code quality standards
  • Testing patterns specific to blockchain scenarios
  • Wallet integration implementation details
  • Performance considerations and debugging strategies
  • Real-world examples and code patterns

The instructions build upon the existing comprehensive .github/copilot-instructions.md file, providing over 1,880 lines of additional specialized guidance tailored for different AI coding agents working on blockchain testing scenarios.

This setup enables AI agents to understand the unique requirements of blockchain DApp testing, wallet automation complexities, and the project's focus on reliability and type safety in end-to-end testing workflows.

Original prompt

This section details on the original issue you should resolve

<issue_title>✨copilot-setup-steps @copilot /.github/copilot-instructions.md
/.github/instructions/**/*.instructions.md
**/AGENTS.md
/CLAUDE.md
/GEMINI.md</issue_title>
<issue_description>Configure instructions for this repository as documented in Best practices for Copilot coding agent in your repository.

</issue_description>

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

Fixes #45

💡 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>
Copilot AI changed the title [WIP] ✨copilot-setup-steps @copilot /.github/copilot-instructions.md /.github/instructions/**/*.instructions.md **/AGENTS.md /CLAUDE.md /GEMINI.md ✨ Configure comprehensive AI coding agent instructions for repository Sep 25, 2025
Copilot AI requested a review from joe10832 September 25, 2025 06:37
@joe10832 joe10832 changed the title ✨ Configure comprehensive AI coding agent instructions for repository ✨copilot-setup-steps Configure comprehensive AI coding agent instructions for repository Sep 25, 2025
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.

@copilot

@joe10832 joe10832 marked this pull request as ready for review September 25, 2025 08:12
Copilot AI review requested due to automatic review settings September 25, 2025 08:12
@joe10832 joe10832 merged commit 140a0bf into main Sep 25, 2025
2 checks passed
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.

.github/instructions/wallet-integration.instructions.md## Pull Request Overview copilot-setup-steps

This PR implements comprehensive GitHub Copilot setup and AI coding agent instructions for the Onchain Test Kit repository, providing specialized guidance for different AI agents working on blockchain testing scenarios.

Key changes include:

  • Creation of agent-specific instruction files (CLAUDE.md, GEMINI.md, AGENTS.md) with tailored guidance for each AI's strengths
  • Addition of detailed development workflow instructions covering TypeScript, Playwright, and blockchain testing patterns
  • Implementation of comprehensive testing strategies including fork mode, wallet automation, and cross-wallet compatibility

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
GEMINI.md Gemini-specific instructions focused on rapid prototyping, developer experience, and performance optimization
CLAUDE.md Claude-specific instructions emphasizing analytical problem solving and comprehensive blockchain testing scenarios
AGENTS.md General AI coding agent instructions covering project overview and architecture principles
.github/instructions/wallet-integration.instructions.md Specialized guidance for wallet implementations covering MetaMask, Coinbase, and Phantom integrations
.github/instructions/testing.instructions.md Comprehensive testing strategies including fork mode and wallet automation patterns
.github/instructions/development.instructions.md Development environment setup, code quality standards, and workflow guidelines
Comments suppressed due to low confidence (1)

CLAUDE.md:1

  • Same security issue as in GEMINI.md - the hardcoded password 'PASSWORD' should be replaced with an environment variable or documented as a placeholder that needs to be replaced with a secure value.
# Claude AI Instructions for Onchain Test Kit

.withMetaMask()
.withSeedPhrase({
seedPhrase: process.env.E2E_TEST_SEED_PHRASE!,
password: 'PASSWORD',
Copy link

Copilot AI Sep 25, 2025

Choose a reason for hiding this comment

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

The hardcoded password 'PASSWORD' in the code example poses a security risk and doesn't follow best practices. Consider using an environment variable like process.env.WALLET_PASSWORD or documenting that this should be replaced with a secure password in actual usage.

Suggested change
password: 'PASSWORD',
password: process.env.WALLET_PASSWORD!,

Copilot uses AI. Check for mistakes.
Comment on lines +100 to +101
seedPhrase: 'test seed phrase',
password: 'password'
Copy link

Copilot AI Sep 25, 2025

Choose a reason for hiding this comment

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

The hardcoded credentials 'test seed phrase' and 'password' should use environment variables or be clearly marked as examples that must be replaced with secure values in actual usage.

Suggested change
seedPhrase: 'test seed phrase',
password: 'password'
// Use environment variables for credentials in real tests
seedPhrase: process.env.E2E_TEST_SEED_PHRASE!,
password: process.env.E2E_TEST_PASSWORD!

Copilot uses AI. Check for mistakes.
Comment on lines +98 to +118
1. Create wallet directory: `src/wallets/NewWallet/`
2. Implement wallet class extending BaseWallet
3. Create Playwright fixtures
4. Add CLI preparation scripts
5. Update configuration builder
6. Add comprehensive tests
7. Update documentation

### Adding New Wallet Actions
1. Define action type in base interfaces
2. Implement in all wallet classes
3. Add parameter validation
4. Create comprehensive tests
5. Update type definitions
6. Document usage examples

### Configuration Changes
1. Maintain backward compatibility
2. Add proper validation
3. Update type definitions
4. Provide migration guides if breaking
Copy link

Copilot AI Sep 25, 2025

Choose a reason for hiding this comment

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

[nitpick] This numbered list format is inconsistent with the bullet point style used elsewhere in the document. For visual consistency, consider using bullet points (-) instead of numbers.

Suggested change
1. Create wallet directory: `src/wallets/NewWallet/`
2. Implement wallet class extending BaseWallet
3. Create Playwright fixtures
4. Add CLI preparation scripts
5. Update configuration builder
6. Add comprehensive tests
7. Update documentation
### Adding New Wallet Actions
1. Define action type in base interfaces
2. Implement in all wallet classes
3. Add parameter validation
4. Create comprehensive tests
5. Update type definitions
6. Document usage examples
### Configuration Changes
1. Maintain backward compatibility
2. Add proper validation
3. Update type definitions
4. Provide migration guides if breaking
- Create wallet directory: `src/wallets/NewWallet/`
- Implement wallet class extending BaseWallet
- Create Playwright fixtures
- Add CLI preparation scripts
- Update configuration builder
- Add comprehensive tests
- Update documentation
### Adding New Wallet Actions
- Define action type in base interfaces
- Implement in all wallet classes
- Add parameter validation
- Create comprehensive tests
- Update type definitions
- Document usage examples
### Configuration Changes
- Maintain backward compatibility
- Add proper validation
- Update type definitions
- Provide migration guides if breaking

Copilot uses AI. Check for mistakes.
Copy link
Member

Choose a reason for hiding this comment

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

Copilot-setup-steps @Copilot

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.

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

2 participants