Skip to content

docs: add AI usage policy for contributors#547

Merged
zachyale merged 3 commits into
developfrom
docs/add-ai-usage-policy
Apr 16, 2026
Merged

docs: add AI usage policy for contributors#547
zachyale merged 3 commits into
developfrom
docs/add-ai-usage-policy

Conversation

@zachyale

@zachyale zachyale commented Apr 16, 2026

Copy link
Copy Markdown
Member

Description

This PR adds a repo-level AI usage policy for contributors. This policy was formed by reflecting on the AI policies instituted by other popular FOSS projects. This specific policy is adapted from the Ghostty AI Usage Policy.

The new policy sets expectations for disclosure, review, testing, and human accountability
when AI tools are used in discussions, issues, or pull requests. It also explicitly
disallows AI-generated media in contributions, and gives maintainers a clear set of rules for
handling low-effort or unreviewed AI submissions.

Changes

  • Add a root AI_POLICY.md

Summary by CodeRabbit

  • Documentation
    • Added an AI Usage Policy requiring contributors to disclose AI assistance (tool and extent), verify and understand AI-assisted submissions, and ensure testing/verification for PRs; mandates human review/editing for AI-generated issue/discussion content; prohibits AI-generated non-text media; unreviewed submissions may be closed and repeated violations blocked; policy targets external contributions and outlines enforcement and project AI philosophy.

@balazs-szucs balazs-szucs left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

lgtm

@coderabbitai

coderabbitai Bot commented Apr 16, 2026

Copy link
Copy Markdown
Contributor

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 3be0e7c1-57b0-4e77-96f8-04160e204c15

📥 Commits

Reviewing files that changed from the base of the PR and between b11bc4e and b159237.

📒 Files selected for processing (1)
  • AI_POLICY.md

📝 Walkthrough

Walkthrough

Added a new repository-level AI_POLICY.md documenting required disclosure of AI tool usage, contributor responsibilities for human review and testing of AI-assisted submissions, different rules for PRs vs issues/discussions, prohibition of AI-generated non-text media, scope limited to external contributors, and enforcement measures.

Changes

Cohort / File(s) Summary
Policy Documentation
AI_POLICY.md
Added a new AI Usage Policy: mandates disclosure (tool name and extent), requires contributors to understand and test AI-assisted PR code, sets reviewer/editing expectations for AI-generated issue/discussion content, forbids AI-generated images/audio/video, scopes to outside contributors, and defines enforcement for unreviewed AI submissions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested reviewers

  • balazs-szucs
  • imnotjames

Poem

🐇 I hopped through clauses, nibbling each line,
“Show your AI’s name, make the intent fine.”
I check every byte and test every part,
A carrot for clarity, and honesty’s art.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The PR title follows the conventional commit format with 'docs:' prefix and clearly describes the addition of an AI usage policy, which matches the changeset.
Description check ✅ Passed The PR description includes all required template sections: Description explaining the purpose and context, and Changes listing what was added, though the Linked Issue field is empty.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/add-ai-usage-policy
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch docs/add-ai-usage-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.

@coderabbitai coderabbitai Bot added the chore label Apr 16, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

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 (1)
AI_POLICY.md (1)

66-68: Optional wording polish for readability.

Line 67 can be tightened by replacing “whether or not” with “whether” to reduce verbosity while keeping meaning intact.

Suggested edit
-preoccupied with whether or not they could, they didn't stop to think
+preoccupied with whether they could, they didn't stop to think
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@AI_POLICY.md` around lines 66 - 68, Replace the phrase "whether or not" with
"whether" in the sentence quoting Ian Malcolm (the line containing "they were so
preoccupied with whether or not they could, they didn't stop to think if they
should") to tighten wording while preserving meaning and punctuation.
🤖 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`:
- Line 54: Replace the incorrect singular verb in the sentence containing the
phrase "Parts of Grimmory has been written with AI assistance, and many
maintainers" by changing "has" to "have" so the sentence reads "Parts of
Grimmory have been written with AI assistance, and many maintainers"; update
that occurrence in AI_POLICY.md.

---

Nitpick comments:
In `@AI_POLICY.md`:
- Around line 66-68: Replace the phrase "whether or not" with "whether" in the
sentence quoting Ian Malcolm (the line containing "they were so preoccupied with
whether or not they could, they didn't stop to think if they should") to tighten
wording while preserving meaning and punctuation.
🪄 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: 2ad1fb60-454a-4f6b-bc03-f1c6a2c287a4

📥 Commits

Reviewing files that changed from the base of the PR and between 16b5747 and 89442f9.

📒 Files selected for processing (1)
  • AI_POLICY.md
📜 Review details
⏰ 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). (1)
  • GitHub Check: Test Suite / Backend Tests
🧰 Additional context used
🪛 LanguageTool
AI_POLICY.md

[style] ~67-~67: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ... Park: _[they] were so preoccupied with whether or not they could, they didn't stop to think i...

(WHETHER)

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

3-40: Strong policy framing and clear contributor expectations.

This section is clear, enforceable, and consistent with the stated PR objective. Nice balance between disclosure requirements and human accountability.

Comment thread AI_POLICY.md Outdated
Comment thread AI_POLICY.md Outdated
Co-authored-by: James Ward <james@notjam.es>

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
AI_POLICY.md (1)

66-68: Optional wording polish for readability.

Line 67 reads a bit cleaner with “whether” instead of “whether or not”.

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

In `@AI_POLICY.md` around lines 66 - 68, Update the quoted Jurassic Park line in
AI_POLICY.md (the sentence starting "they were so preoccupied with whether or
not they could...") to use “whether” instead of “whether or not” so it reads:
"they were so preoccupied with whether they could, they didn't stop to think if
they should", preserving the existing emphasis/italics and punctuation.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@AI_POLICY.md`:
- Around line 66-68: Update the quoted Jurassic Park line in AI_POLICY.md (the
sentence starting "they were so preoccupied with whether or not they could...")
to use “whether” instead of “whether or not” so it reads: "they were so
preoccupied with whether they could, they didn't stop to think if they should",
preserving the existing emphasis/italics and punctuation.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 9ad0d58a-7086-43e4-b481-0848b7cbbca5

📥 Commits

Reviewing files that changed from the base of the PR and between 89442f9 and b11bc4e.

📒 Files selected for processing (1)
  • AI_POLICY.md
📜 Review details
⏰ 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). (5)
  • GitHub Check: Test Suite / Frontend Tests
  • GitHub Check: Test Suite / Backend Tests
  • GitHub Check: Analyze (java-kotlin)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: Frontend Lint Threshold Check
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: CR
Repo: grimmory-tools/grimmory PR: 0
File: CLAUDE.md:0-0
Timestamp: 2026-03-26T16:52:56.437Z
Learning: Create agent-related documentation and guidelines in AGENTS.md
🪛 LanguageTool
AI_POLICY.md

[style] ~67-~67: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ... Park: _[they] were so preoccupied with whether or not they could, they didn't stop to think i...

(WHETHER)

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

54-55: Fix subject–verb agreement in this sentence.

Line 54 should use plural agreement: “Parts of Grimmory have been written…”.

Suggested edit
-Parts of Grimmory has been written with AI assistance, and many maintainers
+Parts of Grimmory have been written with AI assistance, and many maintainers

Co-authored-by: James Ward <james@notjam.es>
@zachyale zachyale merged commit af19acc into develop Apr 16, 2026
10 of 11 checks passed
@zachyale zachyale deleted the docs/add-ai-usage-policy branch April 16, 2026 19:48
zachyale added a commit to zachyale/grimmory that referenced this pull request Apr 17, 2026
zachyale added a commit to zachyale/grimmory that referenced this pull request Apr 17, 2026
dsmouse pushed a commit to dsmouse/grimmory that referenced this pull request May 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants