Skip to content

Docs: Add AI contributions guide in contributing.md and documentation#34502

Merged
huang-julien merged 2 commits into
nextfrom
docs/ai_contribution_guide
Apr 8, 2026
Merged

Docs: Add AI contributions guide in contributing.md and documentation#34502
huang-julien merged 2 commits into
nextfrom
docs/ai_contribution_guide

Conversation

@huang-julien
Copy link
Copy Markdown
Contributor

@huang-julien huang-julien commented Apr 8, 2026

Closes #

What I did

This PR update the contribution guide to include AI assisted PRs. Heavily inspired by Vitest contributing.md.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

no test

Caution

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli-storybook/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook publish.yml --field pr=<PR_NUMBER>

Summary by CodeRabbit

Documentation

  • Updated contribution guidelines with new policies for AI-assisted submissions
  • AI tools used in PR creation must be disclosed
  • Fully AI-generated issues and PRs without human involvement will be labeled and auto-closed after 3 days
  • Low-value or incorrect AI-generated comments may be hidden and could result in spam-related bans

@huang-julien huang-julien added the ci:docs Run the CI jobs for documentation checks only. label Apr 8, 2026
Copy link
Copy Markdown
Contributor

@kylegach kylegach left a comment

Choose a reason for hiding this comment

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

Good work!

@huang-julien huang-julien marked this pull request as ready for review April 8, 2026 16:12
@huang-julien huang-julien changed the title Docs: add AI contributions guide in contributing.md and documentation Docs: Add AI contributions guide in contributing.md and documentation Apr 8, 2026
@huang-julien huang-julien enabled auto-merge April 8, 2026 16:13
@huang-julien huang-julien disabled auto-merge April 8, 2026 16:13
@huang-julien huang-julien merged commit 7022915 into next Apr 8, 2026
19 of 27 checks passed
@huang-julien huang-julien deleted the docs/ai_contribution_guide branch April 8, 2026 16:14
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 8, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 719a8a70-3530-4c48-a189-356897b54d41

📥 Commits

Reviewing files that changed from the base of the PR and between ad5c2a9 and ee5ddc1.

📒 Files selected for processing (2)
  • CONTRIBUTING.md
  • docs/contribute/index.mdx

📝 Walkthrough

Walkthrough

This pull request adds documentation sections to establish guidelines for AI-assisted contributions. Two documentation files were updated with policies requiring human authorship through official templates, mandatory disclosure of AI tools used in PR creation, and procedures for handling fully AI-generated or low-value AI-generated content in issues, pull requests, and comments.

Changes

Cohort / File(s) Summary
AI Contribution Guidelines
CONTRIBUTING.md, docs/contribute/index.mdx
Added new sections establishing policies for AI involvement in contributions, including requirements for human authorship via official templates, disclosure of AI tool usage, auto-close procedures for fully AI-generated submissions, and handling of low-value AI-generated comments.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • #33568: Identical AI contribution policy documentation changes added to CONTRIBUTING.md and contribution guidelines in the Storybook repository.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions Bot mentioned this pull request Apr 8, 2026
14 tasks
@kylegach kylegach added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Apr 8, 2026
@github-actions github-actions Bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Apr 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:docs Run the CI jobs for documentation checks only. documentation patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants