-
Notifications
You must be signed in to change notification settings - Fork 1
Add copilot-instructions.md for repository onboarding #56
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
base: main
Are you sure you want to change the base?
Conversation
|
Unable to perform a code review. You have run out of credits 😔 |
✅ Deploy Preview for aeamcp canceled.
|
Co-authored-by: 0xrinegade <[email protected]>
Co-authored-by: 0xrinegade <[email protected]>
|
@copilot improve more, read whitepapers to get yourself up to speed |
…etails Co-authored-by: 0xrinegade <[email protected]>
Enhanced the copilot instructions with comprehensive context from the whitepapers and technical documentation (commit 2b91772). Added:
File expanded from ~1,555 to ~2,351 words while maintaining the 2-page constraint and keeping all validated build/test instructions intact. |
Created
.github/copilot-instructions.mdto enable coding agents to work efficiently without redundant exploration or hitting known build failures.Repository Context
solana-a2a,solana-mcp) are production-ready with 100% test coverageProject Vision & Protocol Context
Added comprehensive context from whitepapers and technical documentation:
Mission & Purpose:
Key Architectural Innovations:
Dual-Token Economics:
State Structure Documentation:
Documented Build Workflows
Rust (Core Programs)
rust/SDK prevents workspace-wide buildssvmai-tokenhas compilation errors in testsPython SDK
TypeScript SDK
npm ci --legacy-peer-deps # Required for peer dependency resolutionCI/CD Workflows
Documented all GitHub Actions workflows with specific triggers, steps, and quirks:
Known Issues & Workarounds
Five validated issues with exact solutions:
Performance Metrics
All commands tested and timed:
Essential Documentation References
docs/whitepaper/aeamcp-comprehensive-whitepaper.pdf- Complete technical whitepaperdocs/DUAL_TOKENOMICS.md- Dual-token economic model analysisAUDIT_SUMMARY.md- Security audit findings and recommendationsdocs/solana-ai-registries-implementation-plan.md- Implementation specificationsFile expanded from ~1,555 to ~2,351 words, includes critical directive to trust instructions and avoid re-exploration unless information is found to be incorrect.
Original prompt
Your task is to "onboard" this repository to Copilot coding agent by adding a .github/copilot-instructions.md file in the repository that contains information describing how a coding agent seeing it for the first time can work most efficiently.
You will do this task only one time per repository and doing a good job can SIGNIFICANTLY improve the quality of the agent's work, so take your time, think carefully, and search thoroughly before writing the instructions.
- Reduce the likelihood of a coding agent pull request getting rejected by the user due to generating code that fails the continuous integration build, fails a validation pipeline, or having misbehavior. - Minimize bash command and build failures. - Allow the agent to complete its task more quickly by minimizing the need for exploration using grep, find, str_replace_editor, and code search tools. - Instructions must be no longer than 2 pages. - Instructions must not be task specific.Add the following high level details about the codebase to reduce the amount of searching the agent has to do to understand the codebase each time:
Add information about how to build and validate changes so the agent does not need to search and find it each time.
List key facts about the layout and architecture of the codebase to help the agent find where to make changes with minimal searching.
- A description of the major architectural elements of the project, including the relative paths to the main project files, the location
- A description of the checks run prior to check in, including any GitHub workflows, continuous integration builds, or other validation pipelines.
- Document the steps so that the agent can replicate these itself.
- Any explicit validation steps that the agent can consider to have further confidence in its changes.
- Dependencies that aren't obvious from the layout or file structure.
- Finally, fill in any remaining space with detailed lists of the following, in order of priority: the list of files in the repo root, the
- Perform a comprehensive inventory of the codebase. Search for and view: - README.md, CONTRIBUTING.md, and all other documentation files. - Search the codebase for build steps and indications of workarounds like 'HACK', 'TODO', etc. - All scripts, particularly those pertaining to build and repo or environment setup. - All build and actions pipelines. - All project files. - All configuration and linting files. - For each file: - think: are the contents or the existence of the file information that the coding agent will need to implement, build, test, validate, or demo a code change? - If yes: - Document the command or information in detail. - Explicitly indicate which commands work and which do not and the order in which commands should be run. - Document any errors encountered as well as the steps taken to workaround them. - Document any other steps or information that the agent can use to reduce time spent exploring or trying and failing to run bash commands. - Finally, explicitly instruct the agent to trust the instructions and only perform a search if the information in the instruction...of configuration files for linting, compilation, testing, and preferences.
contents of the README, the contents of any key source files, the list of files in the next level down of directories, giving priority to the more structurally important and snippets of code from key source files, such as the one containing the main method.
💡 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.