Skip to content

Proposal: Add AI usage policy#73

Merged
venables merged 1 commit intomainfrom
venables/ai-policy
Mar 26, 2026
Merged

Proposal: Add AI usage policy#73
venables merged 1 commit intomainfrom
venables/ai-policy

Conversation

@venables
Copy link
Contributor

@venables venables commented Mar 26, 2026

Summary

  • Add AI_POLICY.md with rules for AI-assisted contributions (disclosure requirement, human understanding requirement)
  • Add "AI Usage" section to CONTRIBUTING.md referencing the new policy
  • Minor formatting cleanup in CONTRIBUTING.md (line wrapping)

Test plan

  • Review AI_POLICY.md for tone and completeness
  • Review CONTRIBUTING.md AI Usage section wording
  • Verify links between documents work on GitHub

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Introduced new AI contribution policy document outlining guidelines for AI-assisted contributions
    • Enhanced contributing guidelines with a new AI usage section and improved formatting

Introduce AI_POLICY.md with rules for AI-assisted contributions
(disclosure and human understanding requirements) and add an
AI Usage section to CONTRIBUTING.md referencing the new policy.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@coderabbitai
Copy link

coderabbitai bot commented Mar 26, 2026

Walkthrough

This pull request introduces AI contribution guidelines to the project by adding a new AI_POLICY.md document that outlines requirements for AI-assisted contributions, including disclosure and comprehension expectations. The CONTRIBUTING.md file is updated with formatting improvements and a new AI Usage section that references the policy.

Changes

Cohort / File(s) Summary
AI Contribution Policy
AI_POLICY.md, CONTRIBUTING.md
New policy document establishing AI contribution requirements: AI-assisted contributions are permitted with disclosure, contributors must understand and explain their changes, and human review remains a quality boundary. CONTRIBUTING.md updated with formatting improvements and new AI Usage section linking to the policy.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Proposal: Add AI usage policy' directly and clearly describes the main change: introduction of a new AI usage policy through new documentation files (AI_POLICY.md and CONTRIBUTING.md updates).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch venables/ai-policy

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.

Copy link

@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: 1

🧹 Nitpick comments (2)
CONTRIBUTING.md (1)

35-41: Mirror the disclosure requirement here as well.

At Line 35-41, this section highlights comprehension, but contributors may miss the disclosure requirement unless they open the separate policy file. Consider adding one sentence here: “AI-assisted work must be disclosed in the PR description.”

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@CONTRIBUTING.md` around lines 35 - 41, Add a one-sentence disclosure
requirement to the existing "The most important rule: you must understand your
code." section: append a sentence such as "AI-assisted work must be disclosed in
the PR description." to the paragraph so contributors see the disclosure rule
without opening AI_POLICY.md; update the paragraph text near that heading to
include this sentence verbatim.
AI_POLICY.md (1)

12-14: Specify where AI disclosure must appear.

At Line 12, disclosure is required, but the policy does not define where to put it (e.g., PR description, commit message, or issue). Please make this explicit so maintainers can enforce it consistently.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@AI_POLICY.md` around lines 12 - 14, Update the policy sentence "**All AI
usage in any form must be disclosed.**" to explicitly list where disclosures
must appear: require a clear AI disclosure in the pull request description (PR
body), in the corresponding commit message(s) (or squashed commit message), and
in any issue/merge request that introduces the code; optionally add guidance to
include a short note in the changelog/release notes for public releases. Ensure
the edited sentence names these locations verbatim so maintainers can
consistently enforce disclosure.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@AI_POLICY.md`:
- Around line 13-14: Update the wording in AI_POLICY.md by replacing the phrase
"extent that the work was AI-assisted" with "extent to which the work was
AI-assisted" to improve clarity; search for and update any identical occurrences
of that phrase in the document to maintain consistent policy language.

---

Nitpick comments:
In `@AI_POLICY.md`:
- Around line 12-14: Update the policy sentence "**All AI usage in any form must
be disclosed.**" to explicitly list where disclosures must appear: require a
clear AI disclosure in the pull request description (PR body), in the
corresponding commit message(s) (or squashed commit message), and in any
issue/merge request that introduces the code; optionally add guidance to include
a short note in the changelog/release notes for public releases. Ensure the
edited sentence names these locations verbatim so maintainers can consistently
enforce disclosure.

In `@CONTRIBUTING.md`:
- Around line 35-41: Add a one-sentence disclosure requirement to the existing
"The most important rule: you must understand your code." section: append a
sentence such as "AI-assisted work must be disclosed in the PR description." to
the paragraph so contributors see the disclosure rule without opening
AI_POLICY.md; update the paragraph text near that heading to include this
sentence verbatim.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: e84aecb9-7445-477b-9965-142d419e3e1a

📥 Commits

Reviewing files that changed from the base of the PR and between f0e8c6c and 285097c.

📒 Files selected for processing (2)
  • AI_POLICY.md
  • CONTRIBUTING.md

@venables venables merged commit 6f65936 into main Mar 26, 2026
3 checks passed
@venables venables deleted the venables/ai-policy branch March 26, 2026 17:47
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.

2 participants