Skip to content

[repo] Add AI instructions#2811

Open
chernser wants to merge 2 commits intomainfrom
03/30/26/ai_add_skills
Open

[repo] Add AI instructions#2811
chernser wants to merge 2 commits intomainfrom
03/30/26/ai_add_skills

Conversation

@chernser
Copy link
Copy Markdown
Contributor

Summary

  • adds Copilot review instructions
  • adds agents instructions via AGENTS.md
  • adds review skill

Checklist

Delete items not relevant to your PR:

  • Closes #
  • Unit and integration tests covering the common scenarios were added
  • A human-readable description of the changes was provided to include in CHANGELOG
  • For significant changes, documentation in https://github.com/ClickHouse/clickhouse-docs was updated with further explanations or tutorials

@chernser chernser requested a review from mzitnik as a code owner March 30, 2026 19:20
Before reviewing, read:

- `AGENTS.md`
- `docs/ai-review.md`
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the benefit of moving to a separate file?

Comment on lines +20 to +21
1. Identify the changed module and any compatibility-sensitive surfaces.
2. Check correctness, regressions, API and behavior stability, JDBC or R2DBC semantics, and missing focused tests before style suggestions.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

check and flag?

1. Identify the changed module and any compatibility-sensitive surfaces.
2. Check correctness, regressions, API and behavior stability, JDBC or R2DBC semantics, and missing focused tests before style suggestions.
3. Use common Java and driver behavior as a comparison aid, but preserve existing project behavior unless the change is intentionally user-visible.
4. Report findings first, ordered by severity, then open questions or assumptions, then a brief summary.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ordered by severity

how to define severity?

Use it as a compact checklist:

- Confirm the change does not remove or alter any listed feature unintentionally.
- Add or update tests when a change touches a listed feature in a compatibility-sensitive way.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would also add that end-to-end and integration tests should never be modified if the API surface has not been changed


## `client-v2`

- HTTP and HTTPS connectivity: Connects to ClickHouse over HTTP(S), supports endpoint paths, and exposes a basic `ping` health check.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a great list. How can we map it to client components?


In final summaries, state:

- what changed
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we remove duplicates? for example, this one is duplicated in docs/ai-review


## Optional nested AGENTS.md

If a module develops its own conventions, add a nested `AGENTS.md` inside that module.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you going to add separate AGENTS.md for client and JDBC?

@@ -0,0 +1,153 @@
# Copilot Instructions for `clickhouse-java`
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a bit worried that the content overlaps with other files, can we consolidate agent instructions (not skills!) in agents.md and point .github/copilot-instructions.md to it?


Before reviewing, read:

- `AGENTS.md`
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think is necessary, the harness will put AGENTS.md in the context by default.


## Project overview

`clickhouse-java` is a multi-module Maven repository for ClickHouse Java clients and drivers.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we also specify the minimum JVM version

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and minimum supported Java version?


`clickhouse-java` is a multi-module Maven repository for ClickHouse Java clients and drivers.

Main modules:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we list the benchmark module?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants