Skip to content

Add initial Copilot instructions #2948

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 24, 2025
Merged

Add initial Copilot instructions #2948

merged 2 commits into from
Jun 24, 2025

Conversation

mbg
Copy link
Member

@mbg mbg commented Jun 24, 2025

Merge / deployment checklist

  • Confirm this change is backwards compatible with existing workflows.
  • Confirm the readme has been updated if necessary.
  • Confirm the changelog has been updated if necessary.

@Copilot Copilot AI review requested due to automatic review settings June 24, 2025 11:26
@mbg mbg requested a review from a team as a code owner June 24, 2025 11:26
Copy link
Contributor

@Copilot 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

Adds initial guidance for Copilot-assisted reviews by outlining which generated files and workflows to skip during code review.

  • Introduces a Markdown file describing repository structure and review scope.
  • Specifies directories and file patterns that are auto-generated and should be excluded from manual review.
Comments suppressed due to low confidence (1)

.github/copilot-instructions.md:5

  • [nitpick] For clarity, change 'files in the .github/workflows directory that starts with two underscores' to 'files whose filenames start with two underscores in the .github/workflows directory'.
GitHub Actions workflows in the `.github/workflows` directory whose filenames start with two underscores (e.g. `__all-platform-bundle.yml`) are automatically generated using the `pr-checks/sync.sh` script from template files in the `pr-checks/checks` directory. Therefore, you do not need to review files in the `.github/workflows` directory that starts with two underscores. However, you should review changes to the `pr-checks` directory as well as workflows in the `.github/workflows` directory that do not start with underscores.

Copy link
Contributor

@esbena esbena left a comment

Choose a reason for hiding this comment

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

LGTM.

To me, this reads a lot like it has been written for and by a human. The word on the Promptcrafting street is that this might result in instructions that are harder to interpret for copilot.

Nevertheless, my position is that some tailored instructions are better than nothing. So LGTM.

@mbg mbg merged commit 7ab92d0 into main Jun 24, 2025
279 checks passed
@mbg mbg deleted the mbg/copilot-instructions branch June 24, 2025 11:41
@mbg
Copy link
Member Author

mbg commented Jun 24, 2025

Yes, we can always tweak this if it doesn't work well.

@github-actions github-actions bot mentioned this pull request Jun 27, 2025
8 tasks
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