Skip to content

docs: add Copilot code-review instructions#86

Merged
botantler-1[bot] merged 2 commits into
mainfrom
claude/docs-copilot-instructions
Jun 4, 2026
Merged

docs: add Copilot code-review instructions#86
botantler-1[bot] merged 2 commits into
mainfrom
claude/docs-copilot-instructions

Conversation

@devantler

Copy link
Copy Markdown
Contributor

🤖 Generated by the Daily AI Assistant

What

Adds .github/copilot-instructions.md to go-template — the file GitHub Copilot code review reads (repo-wide; it does not read AGENTS.md).

Why

Part of the portfolio-wide rollout tracked in monorepo#1771: every repo should carry a concise, review-focused copilot-instructions.md so Copilot reviews enforce house conventions. go-template had none, so Copilot reviewed its PRs with no project context.

Scope & shape

  • 2718 chars (≤ 4000 — Copilot review truncates beyond that).
  • Short, imperative, review-oriented rules — not a dump of AGENTS.md. Distils the go-template-specific enforce-points: template-not-a-product altitude, go.mod as 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-privilege permissions:, no check-weakening, no hand-edited generated files.
  • Cross-references AGENTS.md and states the keep-in-sync rule both ways.
  • Docs-only; no code or workflow changes.

Created via the GitHub Contents API (no local checkout). Advances #1771 (go-template box).

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.md with review-focused guidance specific to devantler-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.

Comment thread .github/copilot-instructions.md Outdated
@github-actions

github-actions Bot commented Jun 4, 2026

Copy link
Copy Markdown

MegaLinter analysis: Success

Descriptor Linter Files Fixed Errors Warnings Elapsed time
✅ ACTION actionlint 6 0 0 0.3s
✅ ACTION zizmor 6 0 0 0 2.0s
✅ COPYPASTE jscpd yes no no 1.07s
✅ EDITORCONFIG editorconfig-checker 28 0 0 0.04s
✅ GO golangci-lint yes yes no no 21.23s
✅ JSON jsonlint 1 0 0 0.39s
✅ JSON prettier 1 0 0 0 0.48s
✅ JSON v8r 1 0 0 2.21s
✅ MARKDOWN markdownlint 5 0 0 0 1.04s
✅ MARKDOWN markdown-table-formatter 5 0 0 0 0.27s
✅ REPOSITORY checkov yes no no 28.99s
✅ REPOSITORY gitleaks yes no no 0.12s
✅ REPOSITORY git_diff yes no no 0.01s
✅ REPOSITORY grype yes no no 58.34s
✅ REPOSITORY osv-scanner yes no no 2.1s
✅ REPOSITORY secretlint yes no no 0.88s
✅ REPOSITORY syft yes no no 1.46s
✅ REPOSITORY trivy yes no no 11.87s
✅ REPOSITORY trivy-sbom yes no no 0.21s
✅ REPOSITORY trufflehog yes no no 3.99s
✅ SPELL lychee 16 0 0 1.1s
✅ YAML prettier 10 0 0 0 0.74s
✅ YAML v8r 10 0 0 14.04s
✅ YAML yamllint 10 0 0 0.77s

Notices

📣 MegaLinter 9.5.0 is out! Discover the new features and security recommendations in the release announcement. (Skip this info by defining SECURITY_SUGGESTIONS: false)

See detailed reports in MegaLinter artifacts

MegaLinter is graciously provided by OX Security
Show us your support by starring ⭐ the repository

@devantler devantler marked this pull request as ready for review June 4, 2026 22:31
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
@botantler-1 botantler-1 Bot enabled auto-merge (squash) June 4, 2026 23:17
@botantler-1 botantler-1 Bot merged commit aa9e947 into main Jun 4, 2026
17 checks passed
@botantler-1 botantler-1 Bot deleted the claude/docs-copilot-instructions branch June 4, 2026 23:20
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