Skip to content

Rename CLAUDE.md to AGENTS.md and refresh contributor docs#568

Open
ShawnChen-Sirius wants to merge 1 commit into
chdb-io:mainfrom
ShawnChen-Sirius:feat/agents-md
Open

Rename CLAUDE.md to AGENTS.md and refresh contributor docs#568
ShawnChen-Sirius wants to merge 1 commit into
chdb-io:mainfrom
ShawnChen-Sirius:feat/agents-md

Conversation

@ShawnChen-Sirius
Copy link
Copy Markdown
Contributor

@ShawnChen-Sirius ShawnChen-Sirius commented May 11, 2026

Summary

Renames CLAUDE.md to AGENTS.md (content unchanged, reformatted to
the agents.md open standard) and rewrites
CONTRIBUTING.md to be the human-facing contributor guide.

AGENTS.md is kept short on purpose: it stays loaded in AI
coding agent context at all times, so it only carries the chdb-ds
design and testing principles (Fully lazy execution → Natural
execution triggering → Unified architecture → Testing principles).
Everything human-facing — setup, the modify-then-test workflow,
things to avoid, PR conventions, CI matrix, security, release flow —
moves into CONTRIBUTING.md.

Type of change

  • Documentation only

Linked issues

_No related issue;

How to verify

Docs-only PR — render the new files on GitHub and skim:

  • AGENTS.md → 4 sections of chdb-ds design + testing principles (~150 lines)
  • CONTRIBUTING.md → "What chDB is", setup, "I changed X — what to run" table, things to avoid, PR conventions, CI, security, release flow
  • README.md → top banner + §Contributing both point at CONTRIBUTING.md
  • .github/ISSUE_TEMPLATE/bug_report.md / feature_request.md / performance_issue.md + config.yml
  • .github/PULL_REQUEST_TEMPLATE.md → modernised, points at the new docs
  • .cursor/rules/*.mdc → stubs pointing at canonical docs (no duplication)

Lint + tests against this branch:

ruff check datastore --statistics
cd datastore && python -m pytest tests/ -v --tb=short -x

0 lint violations, 10,750 tests passed in ~50s on macOS arm64.

Checklist

- ruff check datastore --statistics passes locally
- Full DataStore suite green
- No new dependencies in requirements.txt
- Tests added — N/A (docs-only)
- Pandas dual-version run — N/A (docs-only)
- User-facing API / docstring updates — N/A (no API change)

Notes for reviewers

File-by-file scope

- AGENTS.md (new, 152 lines) — chdb-ds Design and Testing Principles. Content matches the old CLAUDE.md (Fully lazy execution / Natural exec triggering / Unified architecture / Testing
principles incl. mirror-code pattern); only the format is updated to agents.md standard (title, preamble, numbered sections). Deliberately short so it fits inside every AI coding agent's
always-loaded session context.
- CONTRIBUTING.md (rewritten, ~290 lines) — the human-facing handbook. Covers:
  - What chDB is + cross-repo routing (chdb vs chdb-core)
  - Reporting issues (hints at the new performance_issue template)
  - Setting up (pip install -e . flow; make wheel is release-only)
  - "I changed X — what to run" table with full-suite-by-default callout
  - Things to avoid (crash diagnosis, secrets in fixtures)
  - PR & commit conventions — ClickHouse style: Capitalised verb start, no Conventional-Commit prefix
  - Documentation changes, CI matrix, security, maintainer release flow
- CLAUDE.md — deleted; content moved verbatim into AGENTS.md.
- .github/ISSUE_TEMPLATE/ — drop 13 inherited ClickHouse-upstream templates; add chdb-specific bug_report.md, feature_request.md, performance_issue.md (dataset shape, observed vs expected
timing, optional EXPLAIN / profiling output), and config.yml (Discord / docs routing).
- .github/PULL_REQUEST_TEMPLATE.md — modernised; PR title rule and lint command updated.
- .cursor/rules/{chdb,chdb-ds,git-conventions}.mdc — stubs pointing at AGENTS.md / CONTRIBUTING.md, no content duplication.
- README.md — top banner + §Contributing point at CONTRIBUTING.md; AGENTS.md described as the design doc for AI agents.

Why split AGENTS.md vs CONTRIBUTING.md

AGENTS.md is loaded into every AI coding agent's context on every turn — bloat there costs tokens, dilutes attention on important rules, and slows the session. The chdb-ds design and
testing principles are the highest-leverage content for an LLM-driven agent (these are the rules an agent will misapply the most). Everything operational (setup, build, CI mechanics) is for
 humans, who'll open CONTRIBUTING.md once and read it on a screen.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This docs-only PR consolidates contributor guidance into a new top-level AGENTS.md (aligned with the agents.md standard), refreshes CONTRIBUTING.md and the PR template, replaces inherited ClickHouse issue templates with chDB-specific ones, and removes CLAUDE.md (content folded into AGENTS.md).

Changes:

  • Add AGENTS.md as the canonical contributor guide (humans + AI agents) and link to it from README.md.
  • Rewrite/trim CONTRIBUTING.md and modernize .github/PULL_REQUEST_TEMPLATE.md to match the new workflow and conventions.
  • Replace .github/ISSUE_TEMPLATE/* with chDB-specific bug/feature templates + config, and repoint .cursor/rules/* to AGENTS.md / CONTRIBUTING.md.

Reviewed changes

Copilot reviewed 24 out of 24 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
README.md Adds a prominent contributor link to AGENTS.md.
CONTRIBUTING.md Replaces legacy contributor text with a shorter process/conventions doc and points setup/testing to AGENTS.md.
CLAUDE.md Removes prior agent/contributor guidance (now intended to live in AGENTS.md).
AGENTS.md Adds a new canonical contributor guide, including repo boundaries, workflows, CI notes, and security guidance.
.github/PULL_REQUEST_TEMPLATE.md Replaces ClickHouse-oriented template with chDB-specific PR metadata/checklist.
.github/ISSUE_TEMPLATE/feature_request.md Adds a chDB-specific feature request template.
.github/ISSUE_TEMPLATE/bug_report.md Adds a chDB-specific bug report template.
.github/ISSUE_TEMPLATE/config.yml Disables blank issues and adds contact links (Discord/docs/core repo).
.github/ISSUE_TEMPLATE/96_installation-issues.md Removes inherited ClickHouse template.
.github/ISSUE_TEMPLATE/95_sanitizer-report.md Removes inherited ClickHouse template.
.github/ISSUE_TEMPLATE/90_fuzzing-report.md Removes inherited ClickHouse template.
.github/ISSUE_TEMPLATE/85_bug-report.md Removes inherited ClickHouse template.
.github/ISSUE_TEMPLATE/80_backward-compatibility.md Removes inherited ClickHouse template.
.github/ISSUE_TEMPLATE/70_performance-issue.md Removes inherited ClickHouse template.
.github/ISSUE_TEMPLATE/60_documentation-issue.md Removes inherited ClickHouse template.
.github/ISSUE_TEMPLATE/50_build-issue.md Removes inherited ClickHouse template.
.github/ISSUE_TEMPLATE/45_usability-issue.md Removes inherited ClickHouse template.
.github/ISSUE_TEMPLATE/35_incomplete_implementation.md Removes inherited ClickHouse template.
.github/ISSUE_TEMPLATE/30_unexpected-behaviour.md Removes inherited ClickHouse template.
.github/ISSUE_TEMPLATE/20_feature-request.md Removes inherited ClickHouse template.
.github/ISSUE_TEMPLATE/10_question.md Removes inherited ClickHouse template.
.cursor/rules/git-conventions.mdc Repoints Cursor rule content to CONTRIBUTING.md.
.cursor/rules/chdb.mdc Repoints Cursor crash-diagnosis guidance to AGENTS.md.
.cursor/rules/chdb-ds.mdc Repoints Cursor DataStore testing principles to AGENTS.md.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .github/ISSUE_TEMPLATE/bug_report.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Comment thread CONTRIBUTING.md
Comment thread .github/ISSUE_TEMPLATE/10_question.md Outdated
Comment thread AGENTS.md Outdated
@ShawnChen-Sirius ShawnChen-Sirius force-pushed the feat/agents-md branch 2 times, most recently from 79b2cae to 992cb46 Compare May 14, 2026 23:09
Migrate chdb's CLAUDE.md (chdb-ds Design and Testing Principles) to
AGENTS.md, keeping the content unchanged but reformatting it to
follow the agents.md open standard (https://agents.md). AGENTS.md is
deliberately short — it stays loaded in AI coding agent context at
all times, so it only carries the design and testing principles.

Everything human-facing (setup, the modify-then-test workflow,
things to avoid, PR conventions, CI matrix, security, maintainer
release flow) moves into CONTRIBUTING.md. README.md, the PR
template, and the issue templates now point contributors there.

Companion changes:

- Replace the inherited ClickHouse-upstream .github/ISSUE_TEMPLATE/
  set with chdb-specific bug_report.md, feature_request.md,
  performance_issue.md, and a config.yml routing block.
- Modernise .github/PULL_REQUEST_TEMPLATE.md and adopt the
  ClickHouse-style PR title convention (Capitalised verb start,
  no Conventional-Commit prefix).
- Repoint .cursor/rules/{chdb,chdb-ds,git-conventions}.mdc at
  AGENTS.md / CONTRIBUTING.md instead of duplicating their content.
- Reflect ruff (replacing flake8) as the only PR-gate lint, matching
  upstream PR chdb-io#567.

Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
@ShawnChen-Sirius ShawnChen-Sirius changed the title docs: Add AGENTS.md and refresh contributor-facing docs Add docs: Add AGENTS.md and refresh contributor-facing docs May 14, 2026
@ShawnChen-Sirius ShawnChen-Sirius changed the title Add docs: Add AGENTS.md and refresh contributor-facing docs Rename CLAUDE.md to AGENTS.md and refresh contributor docs May 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants