Skip to content

chore(#2966): Add initial Copilot instructions#418

Merged
ArakTaiRoth merged 1 commit into
alphafrom
benjifranck/2966-copilot-instructions
Sep 10, 2025
Merged

chore(#2966): Add initial Copilot instructions#418
ArakTaiRoth merged 1 commit into
alphafrom
benjifranck/2966-copilot-instructions

Conversation

@bdfranck
Copy link
Copy Markdown
Collaborator

@bdfranck bdfranck commented Aug 14, 2025

This PR adds initial instruction files for GitHub Copilot to use. Topics include...

  • How our documentation pages are structured
  • How we show the LTS version of documentation
  • How we write commits and pull requests

I've created a test PR using these instruction files: GovAlta/ui-components#2801

These instruction files will guide Copilot in the ui-components-docs repo both locally and online. We can continue to update them as we learn.

I've kept the instructions brief to align with the guidelines:

The instructions you add to your custom instruction file(s) should be short, self-contained statements that provide Copilot with relevant information to help it work in this repository. Because the instructions are sent with every chat message, they should be broadly applicable to most requests you will make in the context of the repository.

Questions

  • Am I missing any key instructions?
  • Could I improve the clarity of any of my instructions?
  • Are any of my instructions incorrect or anti-patterns?

How to test

  1. Set up GitHub Copilot with your IDE of choice
  2. Check that Copilot > Use Instructions Files is enabled in your IDE settings
  3. Open Copilot chat
  4. Switch to Agent mode
  5. Prompt Copilot to work on a GitHub Issue.

If it works, you should see the instruction files in the list of references:
image

Additional reading

@netlify
Copy link
Copy Markdown

netlify Bot commented Aug 14, 2025

Deploy Preview for abgov-ui-component-docs ready!

Name Link
🔨 Latest commit 8977e16
🔍 Latest deploy log https://app.netlify.com/projects/abgov-ui-component-docs/deploys/689e1f8e97efcc0008fcc650
😎 Deploy Preview https://deploy-preview-418--abgov-ui-component-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@bdfranck bdfranck force-pushed the benjifranck/2966-copilot-instructions branch from b4a5c0b to 8977e16 Compare August 14, 2025 17:40
@bdfranck bdfranck linked an issue Aug 14, 2025 that may be closed by this pull request
@bdfranck bdfranck marked this pull request as ready for review August 15, 2025 18:02
@ArakTaiRoth ArakTaiRoth merged commit ee35961 into alpha Sep 10, 2025
7 checks passed
@ArakTaiRoth ArakTaiRoth deleted the benjifranck/2966-copilot-instructions branch September 10, 2025 15:38
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.

Docs: Add instructions for GitHub Copilot Agent

2 participants