Add comprehensive Copilot instructions for efficient agent onboarding #66
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a comprehensive
.github/copilot-instructions.mdfile to onboard Copilot coding agents to the SDK Publish repository, enabling them to work more efficiently and reduce the likelihood of build failures or rejected pull requests.What's Added
The instructions file provides essential information that agents previously had to discover through exploration:
Repository Overview: Complete description of the React-based DAppNode package signing web application, its purpose, technology stack (React 18.3.1, TypeScript, Tailwind CSS), and deployment target.
Build Instructions: Validated step-by-step commands with expected timings and known warnings:
yarn install(~1-2 minutes, peer dependency warnings expected)yarn build(~1 minute, source map warnings from dependencies are non-breaking)yarn start(30s startup, babel deprecation warnings expected)npx prettier --write .for code formattingProject Architecture: Detailed directory structure and key file locations including:
src/pages/publishing/) and ownership management (src/pages/ownership/)src/utils/)src/wallet/)CI/CD Pipeline: Documentation of GitHub workflows:
deploy.ymlnetlify.ymlKnown Issues & Workarounds: Documents expected warnings and their root causes:
Code Quality Improvements
Applied prettier formatting to 11 files that had formatting inconsistencies, ensuring the codebase follows the established style guidelines defined in
.prettierrc.Validation
All documented commands have been tested to ensure accuracy. The instructions are designed to minimize agent exploration time while providing comprehensive guidance for making changes without breaking the build system.
Future Copilot agents will be able to immediately understand the project structure, successfully run builds, and make changes with confidence, significantly reducing the likelihood of CI failures or misbehavior.
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.