docs(AGENTS.md): refresh based on last 4 weeks of PRs#714
Merged
Conversation
Agent-Logs-Url: https://github.com/ClickHouse/clickhouse-js/sessions/54d50d94-f830-4b82-a6b3-eb2789d12e44 Co-authored-by: peter-leonov-ch <209667683+peter-leonov-ch@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
peter-leonov-ch
May 9, 2026 18:16
View session
|
|
peter-leonov-ch
approved these changes
May 9, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Updates AGENTS.md to reflect the repository’s current docs/examples/skills layout after recent repo changes, keeping AI-agent contribution guidance aligned with reality.
Changes:
- Refreshes log-message guidance to point at the real
docs/structure (docs/howto/,docs/socket_hang_up_econnreset.md). - Updates examples guidance to acknowledge
examples/web/performance/now exists for browser-safe performance scenarios. - Adds new sections documenting shipped AI-agent skills (
skills/) and embedded docs (docs/), and aligns CHANGELOG guidance with the PR template workflow.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…ing skill Agent-Logs-Url: https://github.com/ClickHouse/clickhouse-js/sessions/d330a245-76e3-47a0-abca-b2811a4c5ede Co-authored-by: peter-leonov-ch <209667683+peter-leonov-ch@users.noreply.github.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
peter-leonov-ch
approved these changes
May 9, 2026
Co-authored-by: Peter Leonov <peter.leonov@clickhouse.com>
peter-leonov-ch
approved these changes
May 9, 2026
peter-leonov-ch
approved these changes
May 9, 2026
1 task
peter-leonov-ch
added a commit
that referenced
this pull request
May 9, 2026
…#717) ## Summary Address unresolved review comments from #714 on `tests/e2e/skills/check.js`: the hardcoded skill list and single-skill symlink assertion let a missing/misdeclared skill (or wrong `path`) slip through. Make the repo-root `skills/` directory the source of truth and verify the full `agents.skills` manifest. - **`packages/client-node/package.json`** — add `clickhouse-js-node-coding` to `agents.skills` so both shipped skills are discoverable. (Also landed independently on `main` via #714 and reconciled during the merge.) - **`tests/e2e/skills/check.js`** — discover skills from `skills/` (subdirs containing `SKILL.md`) and assert, for the installed `@clickhouse/client` tarball: - `agents.skills` declares **exactly** that set (sorted-name `deepStrictEqual` — catches both missing and stale entries). - Each declared entry has `path === ./skills/<name>`, the path resolves inside the installed package, and contains `SKILL.md`. - Each declared skill is symlinked under `.claude/skills/` by `skills-npm` and the symlink target contains `SKILL.md` (no longer hardcoded to `clickhouse-js-node-troubleshooting`). - `@clickhouse/client-web` still ships no `skills/` dir. - Descriptive error if `skills/` is missing; `npm-*` link list is re-read inside each check to avoid stale snapshots. - Merged latest `main` and resolved a conflict in `tests/e2e/skills/check.js` by keeping this PR's source-of-truth-driven implementation over the simpler hardcoded `nodeSkills` array introduced by #714. ## Checklist - [x] Unit and integration tests covering the common scenarios were added --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: peter-leonov-ch <209667683+peter-leonov-ch@users.noreply.github.com> Co-authored-by: copilot <copilot@github.com> Co-authored-by: Peter Leonov <peter.leonov@clickhouse.com>
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.
AGENTS.mdhad drifted from reality after PRs #662–#712: it claimedexamples/webhas noperformance/folder, pointed at a placeholder docs path, and said nothing about theskills/directory or the.claude/skills/setup/skill that replacedcopilot-setup-steps.yml.Summary
performance/— drop the "noperformance/folder underexamples/web" claim; docs(examples): improve AI-agent consumability of coding/ examples #701 added one for browser-safe streaming.docs/layout from Bootstrap embedded docs #677 (docs/socket_hang_up_econnreset.md,docs/howto/) instead of a fictionaldocs/example-log-message.md. The example URL in the snippet now also resolves to a real page (docs/socket_hang_up_econnreset.md).Skillssection — documents the repo-rootskills/directory (docs(skills): add README explaining how to install skills into agent setups #681, feat(skills): ship skills in @clickhouse/client package and add E2E packaging test #682, Addclickhouse-js-node-codingAI agent skill #702):client-node'sprepackships it via@clickhouse/client, theagents.skillsfield ofpackages/client-node/package.jsondeclares which skills are discoverable, and theSkills E2Eworkflow (.github/workflows/e2e-skills.yml, backed bytests/e2e/skills/check.js) asserts the packaged tarball contains the declared skills. Routes contributors to.claude/skills/setup/SKILL.md(Replace copilot-setup-steps.yml with a .claude/skills setup skill #705) instead of re-introducingcopilot-setup-steps.yml.agents.skillsmanifest — addsclickhouse-js-node-codingalongsideclickhouse-js-node-troubleshootingso both shipped skills are discoverable to downstream tooling.tests/e2e/skills/check.jsis extended to verify both skills land in the packaged@clickhouse/clienttarball.Embedded docssection — surfacesdocs/as the preferred home for pages linked from log messages.CHANGELOG.mdat release time.Documentation refresh plus a small manifest/test change to make the second shipped skill discoverable.
Checklist