Skip to content

Commit 1292390

Browse files
authored
Merge branch 'main' into dym-lb-policy
2 parents 9cf3f3c + ad6da44 commit 1292390

1 file changed

Lines changed: 55 additions & 0 deletions

File tree

.agents/skills/pr-review/SKILL.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
name: review-envoy-gateway-pr
3+
description: Review an Envoy Gateway pull request for essential API, implementation, status, and test coverage requirements.
4+
metadata:
5+
short-description: Envoy Gateway PR review workflow
6+
version: "0.1"
7+
---
8+
9+
# Envoy Gateway PR Review Skill
10+
11+
## Inputs
12+
- GitHub PR URL (e.g. review PR: https://github.com/envoyproxy/gateway/pull/8237), or
13+
- A local diff between commits (e.g. review change: git diff 4927877a HEAD)
14+
15+
## Output
16+
- Lead with findings ordered by severity.
17+
- Include exact file and line references.
18+
- Separate required fixes from optional follow-ups.
19+
- If there are no findings, say that clearly and mention residual test or release-note risk.
20+
21+
## Review
22+
- Check API changes, implementation changes, feature coverage, and release notes as applicable.
23+
- Keep findings concise and actionable, with file references when possible.
24+
25+
## Checklist
26+
27+
### API changes
28+
- Make sure changes under `api/` align with https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md
29+
- Make sure changes under `api/` are consistent with existing API patterns in the Gateway API project: https://github.com/kubernetes-sigs/gateway-api/tree/main/apis
30+
- Make sure changes under `api/` are consistent with existing API patterns in this project.
31+
- Try to reuse existing types.
32+
- Keep naming consistent with this project.
33+
- Try to add kubebuilder and CEL validations to catch errors.
34+
- Make sure API validations are tested in `/test/cel-validation`.
35+
- Check backward compatibility for API shape, CRD schema, defaults, versioned structs, and upgrade behavior.
36+
- If a PR mixes API and implementation changes, say whether it should be split into separate PRs.
37+
38+
### Implementation changes
39+
- For changes under `internal/gatewayapi`, check that user-visible errors are surfaced in status.
40+
- For changes under `internal/gatewayapi`, check that status conditions follow the conventions in the Gateway API spec: https://gateway-api.sigs.k8s.io/geps/gep-1364/index.html
41+
- For changes under `internal/gatewayapi`, check that `internal/gatewayapi/testdata` has coverage.
42+
- For changes under `internal/xds/translator`, check that `internal/xds/translator/testdata` has coverage.
43+
44+
### Feature coverage
45+
- For new user-facing features, check that `test/e2e` has coverage.
46+
- For bug fixes, check that `test/e2e` has coverage if the bug is in user-facing code or has user-facing impact.
47+
48+
### Release notes
49+
Release notes should be added to `release-notes/current.yaml` for any of the following changes:
50+
- Bug fixes should be noted as "bug fix" and include a brief description of the issue and the fix.
51+
- New features should be noted as "new feature" and include a brief description of the feature.
52+
- Any breaking changes should be noted as "breaking change" and include a clear description of the change and its impact on users.
53+
- Any change to generated Envoy config (xDS) that moves, removes, or modifies existing config content would break EnvoyPatchPolicies and Extension Servers, so it should be noted as a breaking change. Additions to generated xDS config do not need to be called out.
54+
- Existing API changes should be noted.
55+
- Existing behavior changes should be noted.

0 commit comments

Comments
 (0)