Restructure AGENTS.md with clearer sections and stricter naming rules#24317
Conversation
- Reorganize into Python Code Style, Configuration Models, Development Workflow, Pull Requests, and Documentation sections with a contents list - Add explicit leading-underscore naming rules for methods and variables - Note that nested AGENTS.md/CLAUDE.md files (e.g. clickhouse/AGENTS.md) supplement rather than override the root file - Cross-reference the root AGENTS.md from clickhouse/AGENTS.md
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 4899fc24a7
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: a26b97e41e
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
@codex review |
|
Codex Review: Didn't find any major issues. Nice work! Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
Validation ReportAll 21 validations passed. Show details
|
luisorofino
left a comment
There was a problem hiding this comment.
Looks much cleaner now. Thank you!
What does this PR do?
Restructures the root
AGENTS.mdinto clearer, cross-referenced sections (Python Code Style, Configuration Models, Development Workflow, Pull Requests, Documentation) and tightens the guidance on leading-underscore naming for methods and variables. Also updatesclickhouse/AGENTS.mdto explicitly note that it supplements the rootAGENTS.mdrather than replacing it.Motivation
The previous
AGENTS.mdhad grown organically and lacked clear organization, making it harder for agents and humans to find the relevant rule. This restructuring adds a table of contents, groups related rules together, and clarifies how nestedAGENTS.md/CLAUDE.mdfiles relate to the root file.Review checklist (to be filled by reviewers)
qa/requiredif this PR needs QA validation, orqa/skip-qaif it does not. Exactly one of the two is required.backport/<branch-name>label to the PR and it will automatically open a backport PR once this one is merged