Add AGENTS.md / BUILD.md / UPSTREAM_SYNC.md contributor docs - #45
Add AGENTS.md / BUILD.md / UPSTREAM_SYNC.md contributor docs#45ShawnChen-Sirius wants to merge 1 commit into
Conversation
d388f63 to
79d264c
Compare
There was a problem hiding this comment.
Pull request overview
Adds a set of contributor-facing documentation files (root + scoped subdirectory AGENTS.md overrides) describing chdb-core’s repo boundaries, build/test workflows, C ABI stability expectations, and upstream-sync policy, plus a .gitignore tweak to ensure BUILD.md is tracked on case-insensitive filesystems.
Changes:
- Introduces root
AGENTS.mdplus companion docsBUILD.mdandUPSTREAM_SYNC.md. - Adds scoped
AGENTS.mdfiles underprograms/local/,contrib/, andchdb/to provide directory-specific contributor rules. - Updates
.gitignoreto un-ignoreBUILD.mdwhile keeping/build*ignored.
Reviewed changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
AGENTS.md |
Canonical contributor guide for chdb-core workflows, boundaries, testing, and CI. |
BUILD.md |
Long-form build/test manual with toolchain paths and “what to run” recipes. |
UPSTREAM_SYNC.md |
Policy/guidance for syncing with ClickHouse upstream and routing changes. |
programs/local/AGENTS.md |
C ABI and programs/local/ change-safety guidance for bindings. |
contrib/AGENTS.md |
Guidance for vendored deps/submodules and preserving divergences. |
chdb/AGENTS.md |
Guidance for the internal Python module + build scripts directory. |
.gitignore |
Ensures BUILD.md is tracked despite the /build* ignore pattern. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@chibugai please review this PR and leave a comment with your feedback. |
|
Thanks for the ping, @wudidapaopao. Reviewed the full diff — detailed feedback below. OverallStrong PR. The structure (root Issues to address1. Cross-repo link will be a dead link at merge
2. The sentence about running the sanity check from outside the repo dir is accurate and important, but it sits inside the "Install the freshly built wheel" section, which may lead readers to think the Content that's accurate and valuable (as the CI agent for this project)
Minor nits
Overall: the dead link in §1.1 is the only thing that could cause real confusion at merge time. Everything else is accurate and useful. Happy to help draft the fallback table if that's the preferred path. |
79d264c to
3be3d0e
Compare
3be3d0e to
2e833f2
Compare
2e833f2 to
4c9c2d2
Compare
Introduces contributor docs for both human developers and AI coding agents working on chdb-core, following the agents.md standard. The root AGENTS.md is the canonical entry point — it covers what chdb-core is, the relationship to chdb-io/chdb, the §1.1 cross-repo decision table, the highest-ROI "things to avoid" list, a short setup overview, the "I changed X, what do I run?" workflow, code style, testing strategy, PR conventions (including a fallback for contributors whose chdb fork blocks them from forking chdb-core), and CI / security / maintenance notes. To keep the root AGENTS.md focused on contributor pitfalls and workflows, the longer-form material is split into two companion files: - BUILD.md — full build / test manual: brew vs. pip-only toolchain paths, tox + ccache notes, paste-able commands for full build, library-only build, platform scripts, tests, lint, hygiene, submodule re-pin, the chdb/build/ cleanup quirk, and the end-to-end verification path against chdb-io/chdb. - UPSTREAM_SYNC.md — how chdb-core stays in sync with ClickHouse/ClickHouse: why syncs are sensitive (C ABI, build matrix, chdb-specific contrib divergences) and the routing of upstream-bug reports, submodule bumps, and contrib patches. The repo's .gitignore matches /build* at the root, which on case-insensitive filesystems also catches BUILD.md. A precise !/BUILD.md exemption is added so only this one file is tracked; buildlib/, build/, build_static_lib*, etc. remain ignored. Subdirectory AGENTS.md files override the root for files inside them (per the agents.md spec): - contrib/AGENTS.md — rules for vendored libraries; lists the chdb-specific divergences from upstream (jemalloc je_ prefix, jemalloc-cmake musl tweaks, arrow-cmake jemalloc compat shim, pybind11 pin). - chdb/AGENTS.md — the build-script directory and the Python module bundled in the wheel. - programs/local/AGENTS.md — the public C ABI consumed by every binding repo and the rules for keeping it stable. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
4c9c2d2 to
519ba09
Compare
Summary
Adds contributor docs for chdb-core (humans + AI coding agents), following the https://agents.md standard. The split is intentional so an agent only needs the short top-level file in
context:
stack traces on crashes, sign off with full make test).
commits), and a fallback for opening a PR when GitHub blocks forking chdb-core (piggy-back on your chdb fork).
Also: removes CLAUDE.md (folded into the new docs), and adds !/BUILD.md to .gitignore so the existing /build* rule doesn't swallow it on case-insensitive filesystems.
Test plan