Rename CLAUDE.md to AGENTS.md and refresh contributor docs#568
Open
ShawnChen-Sirius wants to merge 1 commit into
Open
Rename CLAUDE.md to AGENTS.md and refresh contributor docs#568ShawnChen-Sirius wants to merge 1 commit into
ShawnChen-Sirius wants to merge 1 commit into
Conversation
d5cf9b7 to
ebdc4ae
Compare
There was a problem hiding this comment.
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.mdas the canonical contributor guide (humans + AI agents) and link to it fromREADME.md. - Rewrite/trim
CONTRIBUTING.mdand modernize.github/PULL_REQUEST_TEMPLATE.mdto match the new workflow and conventions. - Replace
.github/ISSUE_TEMPLATE/*with chDB-specific bug/feature templates + config, and repoint.cursor/rules/*toAGENTS.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.
ebdc4ae to
277d0b4
Compare
79b2cae to
992cb46
Compare
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]>
992cb46 to
7479b25
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Renames
CLAUDE.mdtoAGENTS.md(content unchanged, reformatted tothe agents.md open standard) and rewrites
CONTRIBUTING.mdto be the human-facing contributor guide.AGENTS.mdis kept short on purpose: it stays loaded in AIcoding 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
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 flowREADME.md→ top banner + §Contributing both point atCONTRIBUTING.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: