docs: add AI-assisted contribution guidelines #32725

stephenjason89 · 2025-07-22T12:29:55Z

🔗 Linked issue

resolves #32719

📚 Description

This PR adds guidelines for AI-assisted contributions to help maintain quality and authenticity in the Nuxt community.

As AI tools become more prevalent in development workflows, these guidelines help:

Maintain authentic human communication in PRs and issues
Ensure contributors understand and can explain their code
Set clear expectations for AI-assisted contributions
Preserve the quality and collaborative spirit of the Nuxt community

bolt-new-by-stackblitz · 2025-07-22T12:29:58Z

Run & review this pull request in StackBlitz Codeflow.

pkg-pr-new · 2025-07-22T12:33:42Z

Open in StackBlitz

@nuxt/kit

npm i https://pkg.pr.new/@nuxt/kit@32725

nuxt

npm i https://pkg.pr.new/nuxt@32725

@nuxt/rspack-builder

npm i https://pkg.pr.new/@nuxt/rspack-builder@32725

@nuxt/schema

npm i https://pkg.pr.new/@nuxt/schema@32725

@nuxt/vite-builder

npm i https://pkg.pr.new/@nuxt/vite-builder@32725

@nuxt/webpack-builder

npm i https://pkg.pr.new/@nuxt/webpack-builder@32725

commit: e335b93

coderabbitai · 2025-07-22T12:49:21Z

Walkthrough

A new section regarding AI-assisted contributions was added to both the pull request template and the contribution guidelines. In the pull request template, contributors are now instructed to ensure that any AI-assisted work reflects their own understanding and is written in their own voice. The contribution guidelines expand on this by outlining principles for using AI tools: contributors should not let AI generate communication on their behalf or submit code they do not fully understand. The documentation also invites feedback on improving AI usage in contributions. No changes were made to code or exported entities.

Estimated code review effort

1 (~5 minutes)

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2be1167 and e335b93.

📒 Files selected for processing (1)

.github/PULL_REQUEST_TEMPLATE.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

.github/PULL_REQUEST_TEMPLATE.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)

GitHub Check: lint-docs
GitHub Check: code
GitHub Check: build

✨ Finishing Touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (2)

.github/PULL_REQUEST_TEMPLATE.md (1)

9-13: Consider mirroring the two-principle structure used in the contribution guide
The template currently reminds authors to write in their own voice, but it omits the complementary “never let an LLM think for you” point that appears in the guidelines. Adding a second sentence or bullet here would keep messaging consistent across documents and avoid confusion.
docs/5.community/4.contribution.md (1)
83-98: Define the “LLM” acronym on first use
Readers unfamiliar with the term may be left guessing. A quick “large language model (LLM)” after the first occurrence improves clarity without adding noise.
-#### Never let an LLM speak for you
+#### Never let a large language model (LLM) speak for you

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 831e65b and 58ad9c1.

📒 Files selected for processing (2)

.github/PULL_REQUEST_TEMPLATE.md (1 hunks)
docs/5.community/4.contribution.md (1 hunks)

🧠 Learnings (3)

📓 Common learnings

Learnt from: Tofandel
PR: nuxt/nuxt#0
File: :0-0
Timestamp: 2024-11-11T12:34:22.648Z
Learning: Ensure that AI-generated summaries accurately reflect the key changes in the PR, focusing on notable changes such as the removal of unused imports and variables starting with underscores.

.github/PULL_REQUEST_TEMPLATE.md (1)

Learnt from: Tofandel
PR: nuxt/nuxt#0
File: :0-0
Timestamp: 2024-11-11T12:34:22.648Z
Learning: Ensure that AI-generated summaries accurately reflect the key changes in the PR, focusing on notable changes such as the removal of unused imports and variables starting with underscores.

docs/5.community/4.contribution.md (1)

Learnt from: Tofandel
PR: nuxt/nuxt#0
File: :0-0
Timestamp: 2024-11-11T12:34:22.648Z
Learning: Ensure that AI-generated summaries accurately reflect the key changes in the PR, focusing on notable changes such as the removal of unused imports and variables starting with underscores.

🪛 LanguageTool

docs/5.community/4.contribution.md

[style] ~95-~95: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ... #### Never let an LLM think for you * Feel free to use AI tools to generate code or explor...

(FEEL_FREE_TO_STYLE_ME)

🧰 Additional context used

🧠 Learnings (3)

📓 Common learnings

Learnt from: Tofandel
PR: nuxt/nuxt#0
File: :0-0
Timestamp: 2024-11-11T12:34:22.648Z
Learning: Ensure that AI-generated summaries accurately reflect the key changes in the PR, focusing on notable changes such as the removal of unused imports and variables starting with underscores.

.github/PULL_REQUEST_TEMPLATE.md (1)

Learnt from: Tofandel
PR: nuxt/nuxt#0
File: :0-0
Timestamp: 2024-11-11T12:34:22.648Z
Learning: Ensure that AI-generated summaries accurately reflect the key changes in the PR, focusing on notable changes such as the removal of unused imports and variables starting with underscores.

docs/5.community/4.contribution.md (1)

Learnt from: Tofandel
PR: nuxt/nuxt#0
File: :0-0
Timestamp: 2024-11-11T12:34:22.648Z
Learning: Ensure that AI-generated summaries accurately reflect the key changes in the PR, focusing on notable changes such as the removal of unused imports and variables starting with underscores.

🪛 LanguageTool

docs/5.community/4.contribution.md

[style] ~95-~95: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ... #### Never let an LLM think for you * Feel free to use AI tools to generate code or explor...

(FEEL_FREE_TO_STYLE_ME)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (20)

GitHub Check: test-fixtures (windows-latest, dev, vite, default, manifest-on, json, 20)
GitHub Check: test-fixtures (windows-latest, built, webpack, async, manifest-on, json, 20)
GitHub Check: test-fixtures (windows-latest, built, vite, default, manifest-off, json, 20)
GitHub Check: test-fixtures (windows-latest, built, webpack, default, manifest-on, json, 20)
GitHub Check: test-fixtures (windows-latest, built, vite, async, manifest-off, json, 20)
GitHub Check: test-fixtures (windows-latest, built, vite, default, manifest-on, json, 20)
GitHub Check: test-fixtures (windows-latest, built, vite, async, manifest-on, json, 20)
GitHub Check: test-fixtures (ubuntu-latest, built, rspack, default, manifest-on, json, 20)
GitHub Check: test-fixtures (ubuntu-latest, built, webpack, default, manifest-on, json, 20)
GitHub Check: test-fixtures (ubuntu-latest, built, webpack, async, manifest-on, json, 20)
GitHub Check: test-fixtures (ubuntu-latest, built, vite, async, manifest-on, json, 20)
GitHub Check: test-fixtures (ubuntu-latest, dev, vite, async, manifest-off, json, 20)
GitHub Check: test-fixtures (ubuntu-latest, built, vite, default, manifest-on, json, 20)
GitHub Check: test-fixtures (ubuntu-latest, built, vite, async, manifest-on, js, 20)
GitHub Check: test-fixtures (ubuntu-latest, dev, vite, async, manifest-on, js, 20)
GitHub Check: test-fixtures (ubuntu-latest, dev, vite, default, manifest-on, json, 20)
GitHub Check: test-fixtures (ubuntu-latest, dev, vite, default, manifest-off, json, 20)
GitHub Check: test-fixtures (ubuntu-latest, dev, vite, async, manifest-on, json, 20)
GitHub Check: test-benchmark
GitHub Check: typecheck (windows-latest, bundler)

.github/PULL_REQUEST_TEMPLATE.md

docs/5.community/4.contribution.md

codspeed-hq · 2025-07-22T12:58:07Z

CodSpeed Performance Report

Merging #32725 will not alter performance

_{Comparing stephenjason89:docs/ai-guidelines (e335b93) with main (831e65b)¹}

Summary

✅ 10 untouched benchmarks

No successful run was found on main (5677748) during the generation of this report, so 831e65b was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩

Co-authored-by: Daniel Roe <daniel@roe.dev>

add reference to original blog post Co-authored-by: Daniel Roe <daniel@roe.dev>

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (3)

docs/5.community/4.contribution.md (3)
85-90: Spell out “LLM” on first use and promote these to a titled sub-section.

Readers unfamiliar with the acronym may stumble, and the two principles currently sit outside the document’s heading hierarchy. A small tweak improves clarity and navigation:
-#### Never let an LLM speak for you
+### 🤖 AI-Assisted Contributions
+
+#### Never let a Large Language Model (LLM) speak for you
(The existing bullets under this heading can remain unchanged.)

91-96: Mirror the acronym expansion in the second heading for consistency.
-#### Never let an LLM think for you
+#### Never let a Large Language Model (LLM) think for you
97-98: Minor grammar improvement for smoother reading.
-Our aim is ensuring quality and maintaining the joy of collaborating and communicating with real people.
+Our aim is to ensure quality while preserving the joy of collaborating and communicating with real people.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 58ad9c1 and 2be1167.

📒 Files selected for processing (1)

docs/5.community/4.contribution.md (1 hunks)

🪛 LanguageTool

docs/5.community/4.contribution.md

[style] ~93-~93: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ... #### Never let an LLM think for you * Feel free to use AI tools to generate code or explor...

(FEEL_FREE_TO_STYLE_ME)

🧰 Additional context used

🪛 LanguageTool

docs/5.community/4.contribution.md

[style] ~93-~93: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ... #### Never let an LLM think for you * Feel free to use AI tools to generate code or explor...

(FEEL_FREE_TO_STYLE_ME)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (20)

GitHub Check: test-fixtures (windows-latest, built, webpack, async, manifest-on, json, 20)
GitHub Check: test-fixtures (windows-latest, built, vite, default, manifest-on, json, 20)
GitHub Check: test-fixtures (windows-latest, built, rspack, async, manifest-on, json, 20)
GitHub Check: test-fixtures (windows-latest, built, webpack, default, manifest-on, json, 20)
GitHub Check: test-fixtures (ubuntu-latest, dev, vite, default, manifest-off, json, 20)
GitHub Check: test-fixtures (ubuntu-latest, built, vite, async, manifest-on, json, 20)
GitHub Check: test-fixtures (ubuntu-latest, built, webpack, default, manifest-on, json, 20)
GitHub Check: test-fixtures (ubuntu-latest, built, rspack, async, manifest-on, json, 20)
GitHub Check: test-fixtures (windows-latest, dev, vite, async, manifest-on, json, 20)
GitHub Check: test-fixtures (ubuntu-latest, built, vite, async, manifest-on, js, 20)
GitHub Check: test-fixtures (windows-latest, dev, vite, async, manifest-off, json, 20)
GitHub Check: test-fixtures (ubuntu-latest, dev, vite, async, manifest-on, json, 20)
GitHub Check: test-fixtures (ubuntu-latest, dev, vite, async, manifest-on, js, 20)
GitHub Check: test-size
GitHub Check: typecheck (windows-latest, bundler)
GitHub Check: test-benchmark
GitHub Check: release-pr
GitHub Check: typecheck (ubuntu-latest, bundler)
GitHub Check: code
GitHub Check: lint-docs

🔇 Additional comments (1)

docs/5.community/4.contribution.md (1)

83-84: Incorporated previous suggestions – looks good.

The introductory sentence now matches the maintainer’s earlier suggestion and reads well in context.

danielroe

perfect!

martinszeltins · 2025-07-25T09:17:53Z

I love this! ❤️ human > perfection

github-actions bot added 4.x documentation labels Jul 22, 2025

stephenjason89 added 2 commits July 22, 2025 20:40

docs: add AI-assisted contribution guidelines

14d067e

docs: add AI guidelines to pull request template

fc4e510

stephenjason89 force-pushed the docs/ai-guidelines branch from 84e8870 to fc4e510 Compare July 22, 2025 12:42

[autofix.ci] apply automated fixes

58ad9c1

stephenjason89 marked this pull request as ready for review July 22, 2025 12:46

stephenjason89 requested a review from danielroe as a code owner July 22, 2025 12:46

coderabbitai bot reviewed Jul 22, 2025

View reviewed changes

danielroe reviewed Jul 22, 2025

View reviewed changes

.github/PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved

docs/5.community/4.contribution.md Outdated Show resolved Hide resolved

docs/5.community/4.contribution.md Outdated Show resolved Hide resolved

stephenjason89 and others added 2 commits July 22, 2025 21:57

docs: improve guideline

3ad0b5c

Co-authored-by: Daniel Roe <daniel@roe.dev>

docs: improve guideline description

3a340b8

add reference to original blog post Co-authored-by: Daniel Roe <daniel@roe.dev>

coderabbitai bot reviewed Jul 22, 2025

View reviewed changes

docs: remove header

e335b93

stephenjason89 force-pushed the docs/ai-guidelines branch from 2be1167 to e335b93 Compare July 22, 2025 14:20

danielroe approved these changes Jul 22, 2025

View reviewed changes

danielroe merged commit f7be62f into nuxt:main Jul 22, 2025
46 of 48 checks passed

github-actions bot mentioned this pull request Jul 22, 2025

v4.0.2 #32710

Merged

danielroe pushed a commit that referenced this pull request Jul 25, 2025

docs: add AI-assisted contribution guidelines (#32725)

e19c166

github-actions bot mentioned this pull request Jul 25, 2025

v3.18.0 #32713

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

docs: add AI-assisted contribution guidelines #32725

docs: add AI-assisted contribution guidelines #32725

Uh oh!

stephenjason89 commented Jul 22, 2025 •

edited by danielroe

Loading

Uh oh!

bolt-new-by-stackblitz bot commented Jul 22, 2025

Uh oh!

pkg-pr-new bot commented Jul 22, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Jul 22, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codspeed-hq bot commented Jul 22, 2025 •

edited

Loading

Uh oh!

coderabbitai bot left a comment

Uh oh!

danielroe left a comment

Uh oh!

Uh oh!

martinszeltins commented Jul 25, 2025

Uh oh!

Uh oh!

Uh oh!

docs: add AI-assisted contribution guidelines #32725

docs: add AI-assisted contribution guidelines #32725

Uh oh!

Conversation

stephenjason89 commented Jul 22, 2025 • edited by danielroe Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔗 Linked issue

📚 Description

Uh oh!

bolt-new-by-stackblitz bot commented Jul 22, 2025

Uh oh!

pkg-pr-new bot commented Jul 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Jul 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Estimated code review effort

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codspeed-hq bot commented Jul 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging #32725 will not alter performance

Summary

Footnotes

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

danielroe left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

martinszeltins commented Jul 25, 2025

Uh oh!

Uh oh!

stephenjason89 commented Jul 22, 2025 •

edited by danielroe

Loading

pkg-pr-new bot commented Jul 22, 2025 •

edited

Loading

coderabbitai bot commented Jul 22, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codspeed-hq bot commented Jul 22, 2025 •

edited

Loading