docs: add Copilot code-review instructions#86
Merged
Conversation
14 tasks
There was a problem hiding this comment.
Pull request overview
Adds repository-wide GitHub Copilot code review instructions via .github/copilot-instructions.md, intended to capture go-template’s house review conventions (template minimalism, Go/toolchain source-of-truth, golangci-lint v2 usage, workflow hygiene) in a concise format that Copilot review will actually read.
Changes:
- Introduces
.github/copilot-instructions.mdwith review-focused guidance specific todevantler-tech/go-template. - Aligns key review expectations with
AGENTS.md(single source of truth for Go version, lint/format expectations, workflow pinning/permissions, etc.).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
✅MegaLinter analysis: Success
Notices📣 MegaLinter 9.5.0 is out! Discover the new features and security recommendations in the release announcement. (Skip this info by defining See detailed reports in MegaLinter artifacts
|
Addresses the Copilot review thread on PR #86: pkg/ is not empty — it intentionally ships pkg/example/ (a real tested sample package meant to be replaced). cmd/ and internal/ are the truly-empty .gitkeep placeholders. > 🤖 Generated by the Daily AI Assistant
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.mdto go-template — the file GitHub Copilot code review reads (repo-wide; it does not readAGENTS.md).Why
Part of the portfolio-wide rollout tracked in monorepo#1771: every repo should carry a concise, review-focused
copilot-instructions.mdso Copilot reviews enforce house conventions. go-template had none, so Copilot reviewed its PRs with no project context.Scope & shape
AGENTS.md. Distils the go-template-specific enforce-points: template-not-a-product altitude,go.modas the single source of truth for the Go version, golangci-lint v2 fmt+run, Conventional-Commit PR titles (squash → changelog),actionlint+ SHA-pinned actions + least-privilegepermissions:, no check-weakening, no hand-edited generated files.AGENTS.mdand states the keep-in-sync rule both ways.Created via the GitHub Contents API (no local checkout). Advances #1771 (go-template box).