Skip to content

Add comprehensive Copilot instructions for coding agents#2268

Merged
pablomendezroyo merged 3 commits intodevelopfrom
copilot/fix-983d3ae7-e0c1-42a0-8b14-3a5282208ee5
Sep 25, 2025
Merged

Add comprehensive Copilot instructions for coding agents#2268
pablomendezroyo merged 3 commits intodevelopfrom
copilot/fix-983d3ae7-e0c1-42a0-8b14-3a5282208ee5

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Sep 25, 2025

This PR adds a comprehensive .github/copilot-instructions.md file to onboard coding agents to the DNP_DAPPMANAGER repository, significantly reducing the time agents need to understand the codebase and preventing common build failures.

What's Included

Repository Overview: Documents that DNP_DAPPMANAGER is the core package manager for DAppNode - a TypeScript monorepo with 25+ packages including React UI, Node.js backend services, and Docker orchestration.

Build System Instructions: Provides validated command sequences for the Yarn Berry workspace system, including:

  • Prerequisites setup (Node.js 20.x, corepack enable)
  • Complete build order with timing expectations (50-60s full build)
  • Development workflows for UI mock servers and Docker containers
  • Common failure scenarios and their solutions

Architecture Documentation: Details the microservices architecture with key packages:

  • admin-ui/ - React web interface with Vite
  • dappmanager/ - Main application entry point
  • common/, types/, toolkit/ - Shared libraries
  • Service packages for Docker, database, notifications, etc.

CI/CD Pipeline: Documents GitHub workflows including unit tests, linting, type checking, and DAppNode SDK integration for builds.

Development Patterns: Guidance for common tasks like adding API endpoints, UI components, validation schemas, and configuration updates.

Validation

All instructions have been tested against the actual repository:

  • ✅ Clean build process from scratch
  • ✅ Mock UI development workflows
  • ✅ Type checking and linting commands
  • ✅ Package-specific build commands

This should significantly improve coding agent effectiveness by providing immediate access to essential repository knowledge instead of requiring extensive exploration each time.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • binaries.soliditylang.org
    • Triggering command: /usr/local/bin/node ./build/cli.bundled.js obtain --solc=0.5.16 (dns block)
  • ethereum.github.io
    • Triggering command: /usr/local/bin/node ./build/cli.bundled.js obtain --solc=0.5.16 (dns block)
  • ns.dappnode.io
    • Triggering command: /usr/local/bin/node --experimental-specifier-resolution=node --import=tsx/esm /home/REDACTED/work/DNP_DAPPMANAGER/DNP_DAPPMANAGER/packages/utils/node_modules/mocha/lib/cli/cli.js ./test/unit --no-config --recursive --no-package --color --exit --extension ts --require dotenv/config --diff --reporter spec --slow 75 --timeout 2000 --ui bdd --watch-ignore node_modules --watch-ignore .git (dns block)
  • relay.trufflesuite.com
    • Triggering command: /usr/local/bin/node ./build/cli.bundled.js obtain --solc=0.5.16 (dns block)
  • solc-bin.ethereum.org
    • Triggering command: /usr/local/bin/node ./build/cli.bundled.js obtain --solc=0.5.16 (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

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:

  • A summary of what the repository does.
  • High level repository information, such as the size of the repo, the type of the project, the languages, frameworks, or target runtimes in use.

Add information about how to build and validate changes so the agent does not need to search and find it each time.

  • For each of bootstrap, build, test, run, lint, and any other scripted step, document the sequence of steps to take to run it successfully as well as the versions of any runtime or build tools used.
  • Each command should be validated by running it to ensure that it works correctly as well as any preconditions and postconditions.
  • Try cleaning the repo and environment and running commands in different orders and document errors and and misbehavior observed as well as any steps used to mitigate the problem.
  • Run the tests and document the order of steps required to run the tests.
  • Make a change to the codebase. Document any unexpected build issues as well as the workarounds.
  • Document environment setup steps that seem optional but that you have validated are actually required.
  • Document the time required for commands that failed due to timing out.
  • When you find a sequence of commands that work for a particular purpose, document them in detail.
  • Use language to indicate when something should always be done. For example: "always run npm install before building".
  • Record any validation steps from documentation.

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
    of configuration files for linting, compilation, testing, and preferences.
  • 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
    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.
- 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...

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

Copilot AI and others added 2 commits September 25, 2025 08:05
Co-authored-by: pablomendezroyo <41727368+pablomendezroyo@users.noreply.github.com>
Co-authored-by: pablomendezroyo <41727368+pablomendezroyo@users.noreply.github.com>
Copilot AI changed the title 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 wi... Add comprehensive Copilot instructions for coding agents Sep 25, 2025
@github-actions github-actions bot temporarily deployed to commit September 25, 2025 08:16 Inactive
@github-actions
Copy link
Copy Markdown

@pablomendezroyo pablomendezroyo marked this pull request as ready for review September 25, 2025 08:22
@pablomendezroyo pablomendezroyo requested a review from a team as a code owner September 25, 2025 08:22
@pablomendezroyo pablomendezroyo merged commit 4de1629 into develop Sep 25, 2025
9 checks passed
@pablomendezroyo pablomendezroyo deleted the copilot/fix-983d3ae7-e0c1-42a0-8b14-3a5282208ee5 branch September 25, 2025 08:22
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.

2 participants