Skip to content

docs: add AI policy#1090

Open
vineethasok wants to merge 1 commit into
mainfrom
add-ai-policy
Open

docs: add AI policy#1090
vineethasok wants to merge 1 commit into
mainfrom
add-ai-policy

Conversation

@vineethasok

@vineethasok vineethasok commented Jun 19, 2026

Copy link
Copy Markdown
Collaborator

Adds an AI_POLICY.md for Click UI, adapted from ClickHouse/ClickHouse's policy and tuned for a design system / component library.

Why

Set a clear, welcoming stance on AI usage so contributors can use AI tools without worrying about stigma, while keeping the bar on quality and responsibility. AI is treated as a normal developer tool — no disclosure required, but you own and review what you submit.

What's in it

  • Welcome AI usage in building, testing, and maintaining the design system.
  • No disclosure required — AI is a normal tool; filter out slop before sending.
  • You own the output — review and understand AI-generated code as if hand-written; no automated maintainer responses.
  • Where AI helps here — accessibility, functional + visual-regression test coverage, TypeScript/prop-API tightening, the CSS Modules migration, and Storybook/build tooling. New components, props, and breaking API changes ship to every consumer, so design them deliberately.
  • Don't game the safety net — no weakening checks or blindly regenerating visual-regression baselines to get green CI; be conservative adding runtime dependencies since they land in every consumer's bundle.
  • IP/licensing unchanged — including not copying patterns/styles from other design systems.

Also adds a short AI Policy section + TOC entry in the README pointing to the file.


Note

Low Risk
Documentation-only; no runtime, API, or CI behavior changes.

Overview
Adds AI_POLICY.md, a contributor-facing policy that welcomes AI for Click UI work while spelling out expectations tailored to a design system (adapted from ClickHouse’s upstream policy).

The doc states AI use does not need disclosure, but authors own and review submitted code like hand-written changes. It encourages AI for accessibility, tests (including visual regression), TypeScript/prop APIs, CSS Modules migration, and tooling; it warns against weakening CI, blindly updating Chromatic baselines, careless new runtime deps, and copying other libraries’ UI without proper licensing.

README.md gains a Contributing AI Policy TOC entry and a short section linking to ./AI_POLICY.md.

Reviewed by Cursor Bugbot for commit fa96401. Bugbot is set up for automated code reviews on this repo. Configure here.

@changeset-bot

changeset-bot Bot commented Jun 19, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: fa96401

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@workflow-authentication-public

Copy link
Copy Markdown
Contributor

Storybook Preview Deployed

✅ Preview URL: https://click-i504rvowk-clickhouse.vercel.app

Built from commit: c6e011753e417e98994887c794f353f9be098b2d

@vineethasok vineethasok enabled auto-merge (squash) June 19, 2026 15:52
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.

1 participant