docs: add Copilot custom instructions for repo maintenance#187
Merged
Conversation
Adds .github/copilot-instructions.md with high-level guidance for future agents working on CodeQL CLI version bumps and pack publishing: judgment calls that need a human, known failure modes to design around, coding agent delegation practices, PR hygiene, and timing expectations. Complements CONTRIBUTING.md's mechanical release process rather than duplicating it. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 84006984-666d-4926-bbb8-795d91f3b5ab
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a repository-level Copilot instructions document to guide future Copilot sessions/agents through CodeQL CLI version bumps and pack publishing work, complementing (but not replacing) the mechanical release process documented in CONTRIBUTING.md.
Changes:
- Introduces
.github/copilot-instructions.mdwith pre-flight checks and “flag to a human” judgment-call guidance. - Documents common failure modes observed in multi-language bump/publish workflows and how to mitigate them.
- Adds guidance on coding-agent task scoping, PR hygiene expectations, and realistic CI/publish timing.
Show a summary per file
| File | Description |
|---|---|
.github/copilot-instructions.md |
Adds high-level Copilot guidance for CodeQL CLI bump and pack publishing maintenance tasks. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Low
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds
.github/copilot-instructions.md— high-level guidance for future Copilot sessions/agents working on CodeQL CLI version bumps and pack publishing in this repo.Why
CONTRIBUTING.md's "Releases & publishing" section is (and remains) the authoritative, mechanical process doc. This file covers what that doc doesn't: judgment calls that need a human, failure modes to design around, coding-agent delegation practices, PR hygiene, and timing expectations — distilled from repeatedly running this process, generalized into standing guidance rather than a history of specific incidents.Contents
No process changes — documentation only.
Co-authored-by: Copilot App 223556219+Copilot@users.noreply.github.com
Copilot-Session: 84006984-666d-4926-bbb8-795d91f3b5ab