Skip to content

Add .github/copilot-instructions.md for Copilot coding agent onboarding#19

Merged
slaFFik merged 5 commits intomainfrom
copilot/add-copilot-instructions-file
Jan 3, 2026
Merged

Add .github/copilot-instructions.md for Copilot coding agent onboarding#19
slaFFik merged 5 commits intomainfrom
copilot/add-copilot-instructions-file

Conversation

Copy link
Contributor

Copilot AI commented Jan 3, 2026

  • Explore repository structure and understand codebase
  • Run and validate build commands (npm ci, npm run build)
  • Run and validate lint commands (npm run lint:js, npm run lint:css, npm run format)
  • Verify plugin distribution (npm run plugin-zip)
  • Document all findings from codebase exploration
  • Create .github/copilot-instructions.md with comprehensive documentation
  • Address code review feedback (clarified lint:css runs Stylelint)
  • Update instructions after linting fixes: all lint commands must now pass with no errors
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 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 instructions is...

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: slaFFik <282234+slaFFik@users.noreply.github.com>
Copilot AI changed the title [WIP] Add copilot instructions for onboarding Add .github/copilot-instructions.md for Copilot coding agent onboarding Jan 3, 2026
Copilot AI requested a review from slaFFik January 3, 2026 13:24
@slaFFik
Copy link
Owner

slaFFik commented Jan 3, 2026

@copilot I have just updated the copilot/add-copilot-instructions-file branch with the fixes of all linting and formatting issues. Please reevaluate the codebase now and update the instructions file in the branch accordingly (make sure to include that all npm run lint:css and npm run list:js should always return no errors).

Co-authored-by: slaFFik <282234+slaFFik@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Jan 3, 2026

@copilot I have just updated the copilot/add-copilot-instructions-file branch with the fixes of all linting and formatting issues. Please reevaluate the codebase now and update the instructions file...

Updated the instructions file in commit 4335531. The documentation now reflects that both npm run lint:js and npm run lint:css must pass with no errors.

@slaFFik slaFFik marked this pull request as ready for review January 3, 2026 14:33
Copilot AI review requested due to automatic review settings January 3, 2026 14:33
@slaFFik slaFFik merged commit 4745835 into main Jan 3, 2026
3 checks passed
@slaFFik slaFFik deleted the copilot/add-copilot-instructions-file branch January 3, 2026 14:33
Copy link

Copilot AI left a 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 adds comprehensive onboarding documentation for GitHub Copilot coding agents by creating a .github/copilot-instructions.md file. The goal is to help coding agents work more efficiently by providing essential repository information upfront, reducing exploration time and minimizing build/validation failures.

  • Documented build commands, validation steps, and critical build notes
  • Provided project layout with file structure and key architectural information
  • Included validation checklist and code style guidelines

Comment on lines +104 to +105
- Single dev dependency: `@wordpress/scripts` (includes webpack, eslint, stylelint, prettier)
- WordPress packages (`@wordpress/blocks`, `@wordpress/i18n`, etc.) are externals resolved at runtime
Copy link

Copilot AI Jan 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The statement "Single dev dependency: @wordpress/scripts" is inaccurate. According to package.json, there are actually 6 devDependencies listed:

  • @wordpress/scripts
  • @wordpress/i18n
  • @wordpress/block-editor
  • @wordpress/components
  • @wordpress/element
  • @wordpress/blocks

While @wordpress/scripts is the primary toolchain, the other WordPress packages are also listed as devDependencies. Consider revising to: "Primary dev dependency: @wordpress/scripts (includes webpack, eslint, stylelint, prettier), with additional WordPress packages as devDependencies"

Suggested change
- Single dev dependency: `@wordpress/scripts` (includes webpack, eslint, stylelint, prettier)
- WordPress packages (`@wordpress/blocks`, `@wordpress/i18n`, etc.) are externals resolved at runtime
- Primary dev dependency: `@wordpress/scripts` (includes webpack, eslint, stylelint, prettier), with additional WordPress packages listed as devDependencies
- WordPress packages (`@wordpress/blocks`, `@wordpress/i18n`, etc.) are treated as externals and resolved at runtime by WordPress

Copilot uses AI. Check for mistakes.
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.

3 participants