Skip to content

chore: add Claude pr-review skill and Copilot instructions - #3475

Draft
Dave Shoup (shouples) wants to merge 2 commits into
mainfrom
djs/pr-review-tooling
Draft

chore: add Claude pr-review skill and Copilot instructions#3475
Dave Shoup (shouples) wants to merge 2 commits into
mainfrom
djs/pr-review-tooling

Conversation

@shouples

Copy link
Copy Markdown
Contributor

Release Notes

N/A - repo tooling only (.claude/ and .github/); no user-facing CLI change.

Breaking Changes

  • None.

Checklist

N/A - this PR adds only .claude/ and .github/ review tooling. The CLI-binary build, Cloud/Platform verification, and integration-test items do not apply, and there are no breaking changes.

What

Sets up AI-assisted PR review for this repo. All three files are new; there are no CLI code changes.

  • .claude/skills/pr-review/SKILL.md - a Claude Code skill for self-review (PR authors) and formal review (reviewers), encoding the repo's non-inferable conventions.
  • .github/copilot-instructions.md - guidance GitHub Copilot loads for its automated PR reviews.
  • .claude/settings.json - basic project-level Claude Code settings; denies reading and editing .env files.

The two review checklists lead with the failure modes that dominated a sample of ~340 non-Copilot inline review comments from the last four months: output/serialization struct-tag design, backend-first validation, error-handling semantics, generator alignment, and failure-path test coverage - rather than the casing and argument-arity rules that golangci-lint / lint-cli already enforce.

Blast Radius

None. Affects only AI-assisted review guidance in this repo; no runtime, build, or customer impact.

References

Test & Review

The two review files were audited by the matching config agents - claude-code-guide for the skill, copilot-guide for the Copilot instructions - and their findings applied (tool-name fix, de-duplicated checklist, a diff-checkable generator rule, and a before/after *Out struct example). Markdown structure was verified (heading order, balanced code fences).

Dave Shoup (shouples) and others added 2 commits August 25, 2026 12:17
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Reorder both checklists to lead with the failure modes human reviewers actually flag (output/serialization struct design, backend-first validation, error-handling semantics, generator alignment, failure-path tests) and demote lint-owned casing/arity guidance. Based on ~340 non-Copilot PR review comments from the last four months.
Copilot AI lite review requested due to automatic review settings August 25, 2026 20:29
@confluent-cla-assistant

Copy link
Copy Markdown

🎉 All Contributor License Agreements have been signed. Ready to merge.
Please push an empty commit if you would like to re-run the checks to verify CLA status for all contributors.

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

This PR adds repo-level AI-assisted PR review tooling for the Confluent CLI, including a Claude Code PR-review skill, GitHub Copilot PR review instructions, and Claude project settings to restrict .env access.

Changes:

  • Add .github/copilot-instructions.md to steer GitHub Copilot reviews toward the repo’s highest-impact CLI review invariants (compatibility, output/serialization, validation, error semantics, tests).
  • Add .claude/skills/pr-review/SKILL.md to provide a structured PR review checklist/process tailored to this codebase.
  • Add .claude/settings.json to deny reading/editing .env files in Claude Code project context.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
.github/copilot-instructions.md Adds GitHub Copilot review guidance aligned to Confluent CLI conventions/checkpoints.
.claude/skills/pr-review/SKILL.md Adds a Claude Code “pr-review” skill with a structured review process and repo-specific checklists.
.claude/settings.json Adds Claude Code permissions to deny read/edit access to .env files.

💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment on lines +196 to +197
- `golangci-lint` owns formatting, import ordering (`gci`: stdlib → default → `confluentinc/` →
`confluentinc/cli/`), naked returns, unused code, and misspellings. Don't comment on any of it.
@shouples Dave Shoup (shouples) changed the title chore: add Claude PR-review skill and Copilot instructions chore: add Claude pr-review skill and Copilot instructions Aug 25, 2026
@sonarqube-confluent

Copy link
Copy Markdown

Quality Gate passed Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube

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