docs: add comprehensive AGENTS.md #10147
Conversation
ti-chi-bot
bot
added
release-note-none
📝 WalkthroughWalkthroughAdds Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
ti-chi-bot
bot
added
the
size/L
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #10147 +/- ##
==========================================
+ Coverage 78.56% 78.59% +0.03%
==========================================
Files 520 520
Lines 69676 69720 +44
==========================================
+ Hits 54739 54797 +58
+ Misses 10990 10973 -17
- Partials 3947 3950 +3
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
|
@liyishuai: adding LGTM is restricted to approvers and reviewers in OWNERS files. DetailsIn response to this: Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
Signed-off-by: JmPotato <github@ipotato.me>
Signed-off-by: JmPotato <github@ipotato.me>
Signed-off-by: JmPotato <github@ipotato.me>
JmPotato
force-pushed
the
add_AGENTS.md
branch
from
f571fa7 to
dd1a0cc
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@AGENTS.md`:
- Line 131: Update the documentation text in AGENTS.md that references GitHub so
the product name is capitalized correctly; locate the line containing "Follow
`.github/pull_request_template.md`; include `Issue Number: close|ref #...`
line." and change any instance of "github" or "GitHub" with incorrect casing to
"GitHub" to match the official capitalization.
🧹 Nitpick comments (2)
AGENTS.md (2)
91-91: Consider noting Go 1.22+ loop variable semantics.While the guidance to avoid capturing loop variables by pointer is sound defensive practice, Go 1.22+ changed loop variable semantics to make each iteration have its own variable. Since the project targets Go 1.25, this advice serves as defense-in-depth but the specific footgun it addresses may be less common.
156-156: Clarify PD_EDITION usage.The checklist mentions "Ensure
PD_EDITIONset correctly" but this is the only reference to this environment variable in the entire document. Consider adding context about what values are valid, when it's required, and what it controls.
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
AGENTS.md
🧰 Additional context used
🪛 LanguageTool
AGENTS.md
[uncategorized] ~5-~5: The official name of this software platform is spelled with a capital “H”.
Context: ....cursorrules. - Copilot rules: none in .github/copilot-instructions.md`. - Purpose: Gi...
(GITHUB)
[uncategorized] ~131-~131: The official name of this software platform is spelled with a capital “H”.
Context: ...ss required. ## PRs & Commits - Follow .github/pull_request_template.md; include `Iss...
(GITHUB)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (13)
- GitHub Check: tso-function-test
- GitHub Check: chunks (6, Tools Test)
- GitHub Check: chunks (9, Microservice Integration(!TSO))
- GitHub Check: chunks (4, Tests(1))
- GitHub Check: chunks (8, TSO Integration Test)
- GitHub Check: chunks (7, Client Integration Test)
- GitHub Check: chunks (10, Microservice Integration(TSO))
- GitHub Check: chunks (3, Unit Test(3))
- GitHub Check: chunks (1, Unit Test(1))
- GitHub Check: chunks (2, Unit Test(2))
- GitHub Check: chunks (5, Tests(2))
- GitHub Check: chunks
- GitHub Check: statics
🔇 Additional comments (7)
AGENTS.md (7)
13-24: Comprehensive build guidance.The build shortcuts section provides clear, actionable commands for various build scenarios. This is helpful for both human and automated contributors.
52-56: Important failpoints discipline guidance.This section provides critical guidance on failpoint management, helping prevent common mistakes like committing generated files or leaving failpoints enabled. This is valuable for both humans and automated contributors.
80-82: Good security-conscious logging guidance.The reminder to never log secrets or PII is an essential security practice that helps prevent accidental data leaks.
101-103: Valuable observability guidance.The warning about high-cardinality labels is particularly important, as this is a common source of metrics database performance issues.
5-5: Fix capitalization: "GitHub" (minor documentation issue).The official name is "GitHub" with a capital "H".
📝 Proposed fix
-- Copilot rules: none in `.github/copilot-instructions.md`. +- Copilot rules: none in `.github/copilot-instructions.md`.Likely an incorrect or invalid review comment.
38-38: The depguard configuration in.golangci.ymlaccurately reflects all documented package bans. The banned packages (github.com/pkg/errors,go.uber.org/atomic,math/rand) and the preference formath/rand/v2are correctly specified in the configuration file.
116-116: No issues found. The version golangci-lint v2.6.0 is correctly pinned in the Makefile and accurately documented in AGENTS.md.
✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.
| - Avoid committing generated artifacts (junitfile, coverage, dashboard caches) unless required. | ||
|
|
||
| ## PRs & Commits | ||
| - Follow `.github/pull_request_template.md`; include `Issue Number: close|ref #...` line. |
There was a problem hiding this comment.
Fix capitalization: "GitHub" (minor documentation issue).
The official name is "GitHub" with a capital "H".
📝 Proposed fix
-- Follow `.github/pull_request_template.md`; include `Iss...
+- Follow `.github/pull_request_template.md`; include `Iss...🧰 Tools
🪛 LanguageTool
[uncategorized] ~131-~131: The official name of this software platform is spelled with a capital “H”.
Context: ...ss required. ## PRs & Commits - Follow .github/pull_request_template.md; include `Iss...
(GITHUB)
🤖 Prompt for AI Agents
In `@AGENTS.md` at line 131, Update the documentation text in AGENTS.md that
references GitHub so the product name is capitalized correctly; locate the line
containing "Follow `.github/pull_request_template.md`; include `Issue Number:
close|ref #...` line." and change any instance of "github" or "GitHub" with
incorrect casing to "GitHub" to match the official capitalization.
|
/retest |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: liyishuai, okJiang, rleungx The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
ti-chi-bot
bot
added
lgtm
approved
and removed
needs-1-more-lgtm
ref tikv#4399 Introduce `AGENTS.md`, a centralized playbook detailing repository-wide guidelines for human and automated contributors. The document consolidates best practices for build, test workflows, linting, code style, error handling, concurrency, metrics, and security standards. Signed-off-by: JmPotato <github@ipotato.me>
ref tikv#4399 Introduce `AGENTS.md`, a centralized playbook detailing repository-wide guidelines for human and automated contributors. The document consolidates best practices for build, test workflows, linting, code style, error handling, concurrency, metrics, and security standards. Signed-off-by: JmPotato <github@ipotato.me>
ref tikv#4399 Introduce `AGENTS.md`, a centralized playbook detailing repository-wide guidelines for human and automated contributors. The document consolidates best practices for build, test workflows, linting, code style, error handling, concurrency, metrics, and security standards. Signed-off-by: JmPotato <github@ipotato.me>
4 participants
What problem does this PR solve?
Issue Number: ref #10206.
What is changed and how does it work?
Check List
Tests
Release note
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.