docs: fix contributor test instructions and SPEC heading table#162
Open
MuhammadHasbiAshshiddieqy wants to merge 1 commit into
Conversation
- CONTRIBUTING.md told contributors to run `npm run test` in "the TypeScript package directories", but toolbox/enrichment has no `test` script and the Python (okf) tests weren't mentioned at all. Replace with per-package-type instructions. - SPEC §4.2: the conventional-headings table listed only Schema / Examples / Citations, but the spec's own §4.3 example and the reference agent use `# Common query patterns` and `# Joins`. Add them to the table so the convention matches actual usage. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
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
1 participant
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
Two documentation fixes.
npm run testin "the TypeScript package directories", buttoolbox/enrichmenthas notestscript (onlymdcodedoes), and the Python (okf) test suite wasn't mentioned at all. Replaced with per-package-type instructions.# Schema/# Examples/# Citations, but the spec's own §4.3 example uses# Joins, and the reference agent emits# Common query patterns. Added both to the table so the documented convention matches actual usage.Docs-only; no code changes.
🤖 Generated with Claude Code