Skip to content

Restructure AGENTS.md with clearer sections and stricter naming rules#24317

Merged
AAraKKe merged 4 commits into
masterfrom
aarakke/agents-md-restructure
Jul 6, 2026
Merged

Restructure AGENTS.md with clearer sections and stricter naming rules#24317
AAraKKe merged 4 commits into
masterfrom
aarakke/agents-md-restructure

Conversation

@AAraKKe

@AAraKKe AAraKKe commented Jul 3, 2026

Copy link
Copy Markdown
Collaborator

What does this PR do?

Restructures the root AGENTS.md into 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 updates clickhouse/AGENTS.md to explicitly note that it supplements the root AGENTS.md rather than replacing it.

Motivation

The previous AGENTS.md had 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 nested AGENTS.md/CLAUDE.md files relate to the root file.

Review checklist (to be filled by reviewers)

  • Feature or bugfix MUST have appropriate tests (unit, integration, e2e)
  • Add qa/required if this PR needs QA validation, or qa/skip-qa if it does not. Exactly one of the two is required.
  • If you need to backport this PR to another branch, you can add the backport/<branch-name> label to the PR and it will automatically open a backport PR once this one is merged

- 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
@AAraKKe AAraKKe added the qa/skip-qa Automatically skip this PR for the next QA label Jul 3, 2026
@AAraKKe AAraKKe requested review from a team as code owners July 3, 2026 14:22
@AAraKKe AAraKKe added the qa/skip-qa Automatically skip this PR for the next QA label Jul 3, 2026

@chatgpt-codex-connector chatgpt-codex-connector Bot 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.

💡 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".

Comment thread AGENTS.md Outdated
@AAraKKe

AAraKKe commented Jul 3, 2026

Copy link
Copy Markdown
Collaborator Author

@codex review

@chatgpt-codex-connector chatgpt-codex-connector Bot 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.

💡 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".

Comment thread AGENTS.md
@AAraKKe

AAraKKe commented Jul 3, 2026

Copy link
Copy Markdown
Collaborator Author

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Nice work!

Reviewed commit: 18782c8fb3

ℹ️ 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".

@dd-octo-sts

dd-octo-sts Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

Validation Report

All 21 validations passed.

Show details
Validation Description Status
agent-reqs Verify check versions match the Agent requirements file
ci Validate CI configuration and code coverage settings
codeowners Validate every integration has a CODEOWNERS entry
config Validate default configuration files against spec.yaml
dep Verify dependency pins are consistent and Agent-compatible
http Validate integrations use the HTTP wrapper correctly
imports Validate check imports do not use deprecated modules
integration-style Validate check code style conventions
jmx-metrics Validate JMX metrics definition files and config
labeler Validate PR labeler config matches integration directories
legacy-signature Validate no integration uses the legacy Agent check signature
license-headers Validate Python files have proper license headers
licenses Validate third-party license attribution list
metadata Validate metadata.csv metric definitions
models Validate configuration data models match spec.yaml
openmetrics Validate OpenMetrics integrations disable the metric limit
package Validate Python package metadata and naming
qa-label Validate the pull request declares whether it needs QA for the next Agent release
readmes Validate README files have required sections
saved-views Validate saved view JSON file structure and fields
version Validate version consistency between package and changelog

View full run

@AAraKKe AAraKKe enabled auto-merge July 3, 2026 15:21

@luisorofino luisorofino left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks much cleaner now. Thank you!

@AAraKKe AAraKKe added this pull request to the merge queue Jul 6, 2026
Merged via the queue into master with commit 690509a Jul 6, 2026
30 checks passed
@AAraKKe AAraKKe deleted the aarakke/agents-md-restructure branch July 6, 2026 10:45
@dd-octo-sts dd-octo-sts Bot added this to the 7.82.0 milestone Jul 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants