docs(skills): add README explaining how to install skills into agent setups#681
Merged
Conversation
Agent-Logs-Url: https://github.com/ClickHouse/clickhouse-js/sessions/9e19529d-a0ff-4143-839f-89e345804a82 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
April 26, 2026 18:06
View session
|
|
Contributor
There was a problem hiding this comment.
Pull request overview
Adds first-party installation instructions for the repository’s skills/ directory so users can wire skills into common agent setups (Claude Code, AGENTS.md-based agents, and generic agents), making the skill(s) discoverable and usable without external links.
Changes:
- Add
skills/README.mddescribing what a skill contains (SKILL.md,reference/,evals/). - Document installation steps for Claude Code and AGENTS.md-based agents (e.g., Codex CLI), plus a generic fallback workflow.
- Provide an index of currently available skills.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Agent-Logs-Url: https://github.com/ClickHouse/clickhouse-js/sessions/fc833f07-e1b1-47a8-93b9-7820f87b0b1e Co-authored-by: peter-leonov-ch <209667683+peter-leonov-ch@users.noreply.github.com>
Agent-Logs-Url: https://github.com/ClickHouse/clickhouse-js/sessions/679a9c8c-ee0c-47e6-beab-30c87c0b630d Co-authored-by: peter-leonov-ch <209667683+peter-leonov-ch@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (1)
README.md:89
- The TypeScript snippet in Quick start was reformatted to use double quotes and semicolons, which conflicts with this repo’s Prettier settings (
singleQuote: true,semi: false). To keep examples consistent with the rest of the codebase and avoid confusing users, please revert the snippet to single quotes and remove trailing semicolons (also make the inline comment quote style consistent).
import { createClient } from '@clickhouse/client' // or '@clickhouse/client-web'
const client = createClient({
url: process.env.CLICKHOUSE_URL ?? 'http://localhost:8123',
username: process.env.CLICKHOUSE_USER ?? 'default',
password: process.env.CLICKHOUSE_PASSWORD ?? '',
})
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
peter-leonov-ch
approved these changes
Apr 26, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
1 task
peter-leonov-ch
added a commit
that referenced
this pull request
May 9, 2026
`AGENTS.md` had drifted from reality after PRs #662–#712: it claimed `examples/web` has no `performance/` folder, pointed at a placeholder docs path, and said nothing about the `skills/` directory or the `.claude/skills/setup/` skill that replaced `copilot-setup-steps.yml`. ## Summary - **Examples › `performance/`** — drop the "no `performance/` folder under `examples/web`" claim; #701 added one for browser-safe streaming. - **Log-message docs guidance** — point at the real `docs/` layout from #677 (`docs/socket_hang_up_econnreset.md`, `docs/howto/`) instead of a fictional `docs/example-log-message.md`. The example URL in the snippet now also resolves to a real page (`docs/socket_hang_up_econnreset.md`). - **New `Skills` section** — documents the repo-root `skills/` directory (#681, #682, #702): `client-node`'s `prepack` ships it via `@clickhouse/client`, the `agents.skills` field of `packages/client-node/package.json` declares which skills are discoverable, and the `Skills E2E` workflow (`.github/workflows/e2e-skills.yml`, backed by `tests/e2e/skills/check.js`) asserts the packaged tarball contains the declared skills. Routes contributors to `.claude/skills/setup/SKILL.md` (#705) instead of re-introducing `copilot-setup-steps.yml`. - **`agents.skills` manifest** — adds `clickhouse-js-node-coding` alongside `clickhouse-js-node-troubleshooting` so both shipped skills are discoverable to downstream tooling. `tests/e2e/skills/check.js` is extended to verify both skills land in the packaged `@clickhouse/client` tarball. - **New `Embedded docs` section** — surfaces `docs/` as the preferred home for pages linked from log messages. - **CHANGELOG guidance** — aligns with the PR template: entry goes in the PR description and is folded into `CHANGELOG.md` at release time. Documentation refresh plus a small manifest/test change to make the second shipped skill discoverable. ## Checklist - [x] A human-readable description of the changes was provided to include in CHANGELOG --------- 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: 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.
README.mdwith a brief list of available skillsnpx skills add ClickHouse/clickhouse-jsworkflow (using theskillsCLI)