docs: add an agent entry point and document the spec as the source of truth - #248
Open
nielspardon wants to merge 1 commit into
Open
docs: add an agent entry point and document the spec as the source of truth#248nielspardon wants to merge 1 commit into
nielspardon wants to merge 1 commit into
Conversation
… truth Nothing in the repository stated that it implements the Substrait specification rather than defining it, or how to proceed when the spec is ambiguous, and nothing said that the PR title and description are linted together and become the squash-merge commit body that semantic-release turns into release notes. CONTRIBUTING.md now covers both, AGENTS.md (imported by CLAUDE.md) carries the agent-specific half, and the PR template states the one thing a PR author needs while typing. Also fixes the documented setup step: `uv sync --extra test` fails because no `test` extra exists.
nielspardon
marked this pull request as ready for review
August 7, 2026 18:15
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.
Three gaps in the contributor docs, and no entry point for agents at all.
CONTRIBUTING.mdnow leads with that and gives an escalation order — the sibling bindings under Active Libraries for modeling questions, the engines under Powered by Substrait for runtime semantics, a clarification issue upstream only when neither shows a consensus.AGENTS.md, imported byCLAUDE.md, carries the agent-specific half: filling a spec gap with something plausible and then describing it as spec-defined is a failure mode worth naming outright.semantic-releaseturns into release notes. The ⚠ BREAKING CHANGES section of v0.30.0 shows the cost: one entry is just a repeated commit subject, because that commit marked its title with!but put the prose under a## Breaking changeheading instead of aBREAKING CHANGE:footer, so its migration instruction never reached the notes. The new.github/pull_request_template.mdstates only what a PR author needs while typing, and links the rest.uv sync --extra testfails, because notestextra exists. The testing section now also says why a clean run reports skips — thetests/sqlengine round-trips are opt-in behindSUBSTRAIT_ENGINE_TESTS=1— and which examples CI does not cover.>>>sessions runnable:p.SerializeToString()beforepexists,mesage=formessage=, and a danglingfunctions:line.🤖 Generated with AI