Skip to content

Conversation

Copy link

Copilot AI commented Sep 25, 2025

This PR adds a comprehensive .github/copilot-instructions.md file 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 formatting

Project Architecture: Detailed directory structure and key file locations including:

  • Two main user flows: package publishing (src/pages/publishing/) and ownership management (src/pages/ownership/)
  • Utility functions for IPFS, ENS, and blockchain interactions (src/utils/)
  • Wallet integration using Reown AppKit (src/wallet/)
  • Configuration files and their purposes

CI/CD Pipeline: Documentation of GitHub workflows:

  • Production deployment to GitHub Pages via deploy.yml
  • PR preview deployments to Netlify via netlify.yml
  • No automated linting/testing (manual prettier required)

Known Issues & Workarounds: Documents expected warnings and their root causes:

  • Source map warnings from dependencies (non-breaking)
  • Bundle size warnings (expected due to crypto/IPFS dependencies)
  • Babel deprecation warnings (Create React App maintenance status)

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:

  • 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...

💡 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.

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 efficient agent onboarding Sep 25, 2025
Copilot finished work on behalf of pablomendezroyo September 25, 2025 11:23
@github-actions
Copy link

@github-actions github-actions bot temporarily deployed to pull request September 25, 2025 11:31 Inactive
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