Skip to content

Conversation

@ematipico
Copy link
Member

Summary

This PR revamps the AI usage inside this repository

  • adds a disclosure notice, heavily inspired by the ghostty one
  • CLAUDE.md is now a symbolic link to the contribution guide
  • adds AGENTS.md, which is now a symbolic link to the contribution guide

Test Plan

Docs

@changeset-bot
Copy link

changeset-bot bot commented Oct 26, 2025

⚠️ No Changeset found

Latest commit: fd99c17

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

@ematipico ematipico requested review from a team October 26, 2025 09:37
@ematipico ematipico changed the title chore: AI docs revamp chore: ai docs revamp Oct 26, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 26, 2025

Walkthrough

This PR adds CONTRIBUTING.md at the repository root, introducing an "AI assistance notice" entry and a duplicated "AI assistance notice" section in the document. It also prepends an AI-assistance disclosure HTML comment block to .github/PULL_REQUEST_TEMPLATE.md. No exported/public declarations or behavioural code changes were made.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The PR title "chore: ai docs revamp" accurately reflects the main objective of the changeset, which is to revamp AI-related documentation by adding disclosure notices and creating symbolic links for contribution guides. The title is concise, specific, and clearly communicates the nature of the changes—a documentation update focused on AI policies. It avoids vague terminology and would help colleagues scanning the git history understand the primary purpose of this change.
Description Check ✅ Passed The PR description is directly related to the changeset and provides clear context about the changes being made. It explains the motivation (revamping AI usage policies in the repository), lists the specific changes (adding a disclosure notice, creating symbolic links for CLAUDE.md and AGENTS.md), and even references the inspiration source. The description aligns well with the raw summary showing additions to contribution guidelines and disclosure notices across multiple files.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore/ai-disclosure-revamp

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 43db8e3 and fd99c17.

📒 Files selected for processing (1)
  • CONTRIBUTING.md (2 hunks)
🧰 Additional context used
🪛 LanguageTool
CONTRIBUTING.md

[uncategorized] ~60-~60: Possible missing comma found.
Context: ...ulted ChatGPT to understand the codebase but the solution > was fully authored man...

(AI_HYDRA_LEO_MISSING_COMMA)

🔇 Additional comments (1)
CONTRIBUTING.md (1)

47-70: AI assistance notice section looks good.

The disclosure guidance is clear and well-structured. The examples provide practical context, and the emphasis on respectful disclosure will help maintain code review quality.

The AI-generated summary mentions that the AI assistance notice content is duplicated within this document. I can only find one instance (lines 47–70). Please verify whether the section appears twice elsewhere in the file, or if the summary is inaccurate.


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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fe90c78 and ac18d98.

📒 Files selected for processing (5)
  • .github/PULL_REQUEST_TEMPLATE.md (1 hunks)
  • AGENTS..md (1 hunks)
  • CLAUDE.md (0 hunks)
  • CLAUDE.md (1 hunks)
  • CONTRIBUTING.md (2 hunks)
🧰 Additional context used
🪛 GitHub Actions: Pull request Markdown
AGENTS..md

[error] 61-61: MD028/no-blanks-blockquote Blank line inside blockquote https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md028.md

🪛 GitHub Check: lint
CONTRIBUTING.md

[failure] 61-61: Blank line inside blockquote
CONTRIBUTING.md:61 MD028/no-blanks-blockquote Blank line inside blockquote https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md028.md

🪛 LanguageTool
CONTRIBUTING.md

[uncategorized] ~54-~54: Possible missing article found.
Context: ... If you avail of AI assistance to make pull request, you must disclose it in the pu...

(AI_HYDRA_LEO_MISSING_A)


[uncategorized] ~62-~62: Possible missing comma found.
Context: ...ulted ChatGPT to understand the codebase but the solution > was fully authored manua...

(AI_HYDRA_LEO_MISSING_COMMA)

🔇 Additional comments (3)
.github/PULL_REQUEST_TEMPLATE.md (1)

1-5: AI-assistance disclosure block is well-placed and correct.

The new HTML comment block clearly prompts contributors to disclose AI assistance and provides a direct link to the policy. Good positioning at the top of the template.

CONTRIBUTING.md (1)

47-72: AI assistance notice section is well-written and appropriately emphatic.

The new section clearly communicates the disclosure requirement with good rationale, practical examples, and a respectful tone toward maintainers. Once the formatting and grammar issues are resolved, this will be solid.

AGENTS..md (1)

1-1: File doesn't exist—review comment is based on incorrect assumptions.

The file AGENTS.md (or AGENTS..md) doesn't exist in the repository. If the PR intends to add this file, verify it's actually been committed; if not, this review comment is premature. If the file was meant to exist elsewhere or under a different name, clarify with the PR author.

Likely an incorrect or invalid review comment.

ematipico and others added 3 commits October 26, 2025 09:40
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@ematipico ematipico requested a review from nhedger October 26, 2025 12:20
Co-authored-by: Nicolas Hedger <[email protected]>
@ematipico ematipico requested a review from a team October 26, 2025 12:56
@ematipico ematipico merged commit 0a59995 into main Oct 26, 2025
4 checks passed
@ematipico ematipico deleted the chore/ai-disclosure-revamp branch October 26, 2025 15:26
Jagget pushed a commit to Jagget/biome that referenced this pull request Oct 27, 2025
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Nicolas Hedger <[email protected]>
Conaclos pushed a commit that referenced this pull request Nov 1, 2025
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Nicolas Hedger <[email protected]>
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.

3 participants