-
-
Notifications
You must be signed in to change notification settings - Fork 2
✨ Add comprehensive GitHub Copilot coding agent setup #44
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
✨ Add comprehensive GitHub Copilot coding agent setup #44
Conversation
Co-authored-by: joe10832 <103850533+joe10832@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR implements comprehensive GitHub Copilot coding agent instructions and supporting documentation to improve the development experience with AI assistance. The setup provides Copilot with deep context about the Onchain Test Kit project's architecture, patterns, and development practices.
- Adds detailed Copilot instructions covering project architecture, API patterns, and testing approaches
- Establishes comprehensive contributing guidelines for consistent development workflow
- Implements structured GitHub templates for better issue tracking and pull request reviews
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
.github/copilot-instructions.md |
Comprehensive 328-line guide providing Copilot with project context, architecture details, and coding patterns |
CONTRIBUTING.md |
Detailed 319-line contributor guide covering development setup, workflows, and architecture guidelines |
.github/pull_request_template.md |
Structured PR template with testing, documentation, and compatibility checklists |
.github/ISSUE_TEMPLATE/bug_report.md |
Bug report template with environment info and reproduction steps |
.github/ISSUE_TEMPLATE/feature_request.md |
Feature request template with API design examples and implementation considerations |
.github/ISSUE_TEMPLATE/documentation.md |
Documentation issue template for reporting docs problems and improvements |
.github/ISSUE_TEMPLATE/config.yml |
Issue configuration with helpful links and disabled blank issues |
|
|
||
| ## Project Overview | ||
|
|
||
| The Onchain Test Kit is an end-to-end testing toolkit for blockchain applications, powered by Playwright. It provides comprehensive wallet automation and testing capabilities for DApps with support for MetaMask, Coinbase Wallet, and Phantom wallets. |
Copilot
AI
Sep 25, 2025
•
edited by joe10832
Loading
edited by joe10832
There was a problem hiding this 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[nitpick] The project description mentions 'end-to-end testing toolkit' but doesn't clarify what 'Onchain' specifically means in this context. Consider adding a brief explanation of what 'onchain' refers to (blockchain-based testing, on-chain interactions, etc.) to help Copilot better understand the domain.
| The Onchain Test Kit is an end-to-end testing toolkit for blockchain applications, powered by Playwright. It provides comprehensive wallet automation and testing capabilities for DApps with support for MetaMask, Coinbase Wallet, and Phantom wallets. | |
| The Onchain Test Kit is an end-to-end testing toolkit for blockchain applications, powered by Playwright. Here, "onchain" refers to interactions and testing that occur directly on blockchain networks—such as deploying and interacting with smart contracts, simulating transactions, and verifying on-chain state changes. It provides comprehensive wallet automation and testing capabilities for DApps with support for MetaMask, Coinbase Wallet, and Phantom wallets. @copilot-instructions.mdhttps://api.githubcopilot.com/mcp/readonly |
|
|
||
| 1. **Test Structure** | ||
| ```typescript | ||
| import { createOnchainTest } from '@coinbase/onchaintestkit'; |
Copilot
AI
Sep 25, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The import statement uses '@coinbase/onchaintestkit' but the repository URL suggests this might not be the correct package name. Verify that this matches the actual published package name or update it to reflect the correct import path.
| import { createOnchainTest } from '@coinbase/onchaintestkit'; | |
| import { createOnchainTest } from '@coinbase/onchain-testkit'; |
| git clone https://github.com/your-username/onchaintestkit.git | ||
| cd onchaintestkit |
Copilot
AI
Sep 25, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The repository URL uses a generic placeholder 'your-username/onchaintestkit' but should reference the actual repository URL from the PR metadata: 'MunyayLLC/https-github.com-joe10832-onchaintestkit' for consistency.
| git clone https://github.com/your-username/onchaintestkit.git | |
| cd onchaintestkit | |
| git clone https://github.com/MunyayLLC/https-github.com-joe10832-onchaintestkit.git | |
| cd https-github.com-joe10832-onchaintestkit |
joe10832
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This PR implements comprehensive GitHub Copilot coding agent instructions and supporting documentation as requested in issue #copilot-setup-steps, following the best practices outlined in the GitHub Copilot coding agent guidelines.
What's Added
🤖 Copilot Instructions (
.github/copilot-instructions.md)A comprehensive 327-line guide that provides GitHub Copilot with deep context about the Onchain Test Kit project, including:
configBuilder.tsand wallet implementations📚 Contributing Guidelines (
CONTRIBUTING.md)A detailed 318-line contributor guide covering:
🎯 GitHub Templates
Benefits for Copilot
This setup enables GitHub Copilot to:
Example: Before vs After
Before: Copilot might suggest generic Playwright code
After: Copilot can suggest project-specific wallet interaction patterns
Quality Assurance
npm run test)npm run build)npm run lint)This implementation provides GitHub Copilot with the context needed to understand the project's blockchain testing domain, wallet automation patterns, and architectural decisions, enabling more accurate and helpful code suggestions for contributors.
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.