sungwy commented on code in PR #18168: URL: https://github.com/apache/iceberg/pull/18168#discussion_r4053960179
########## AGENTS.md: ########## @@ -163,19 +165,29 @@ The `api/` module has the strongest stability guarantees — breaking changes ar ## PR & Commit Conventions +- **Never open a PR generated from an issue without a human in the loop.** +- Search open PRs and issues for the same problem before starting. Don't add a duplicate. - PR titles follow `Module: Description` format (e.g., `Core: Fix ...`, `Spark: Add ...`, `Docs: Update ...`). - One concern per PR. Unrelated whitespace, import, or formatting changes go in separate PRs. - Keep first version of a PR minimal — defer recovery, optimization, and edge cases to follow-ups. +- Before opening a PR, run `./gradlew spotlessApply` and build and test the modules you changed (see Commands). Never submit code you have not compiled and run. +- PR description is one paragraph, under 120 words: the problem, the approach, and anything a reviewer would not guess from the diff. Plus the issue link, the test plan, and the AI Disclosure block. Nothing else. +- Never restate the diff: no file-by-file walkthrough, no per-method summaries, no "Changes made" checklist, no "Summary", "Background", "Motivation", or "Testing" headings, no emoji. +- If the change needs more than a paragraph to explain, the PR is too big. Review Comment: I find this a bit subjective and confusing: a "big PR" can satisfy this requirement by pointing to a design document to do most of the explanation. I feel my confusion is rooted in the fact that we are trying to combine two orthogonal attributes of a PR that may not have a direct correlation - the length of the PR description, and the length or complexity of the code changes in the PR. I think it would be simpler if we just targeted one of those. We already have line 174 on PR description. shall we just remove this? ```suggestion ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
