Skip to content

Add AI usage disclosure guidelines to CONTRIBUTING.md#925

Merged
curquiza merged 1 commit intomainfrom
meili-bot/add-ai-disclosure-guidelines
Jan 19, 2026
Merged

Add AI usage disclosure guidelines to CONTRIBUTING.md#925
curquiza merged 1 commit intomainfrom
meili-bot/add-ai-disclosure-guidelines

Conversation

@meili-bot
Copy link
Contributor

@meili-bot meili-bot commented Jan 19, 2026

This PR is auto-generated.

This PR adds guidelines about AI tool usage in contributions:

  • New "Coding with AI" section explaining our policy on AI-assisted contributions
  • Reminder in step 5 of "How to Contribute" about disclosing AI usage

Our policy: AI usage is accepted, provided contributors disclose it in their PR description. This transparency helps maintainers during code review.

Summary by CodeRabbit

  • Documentation
    • Updated contribution guidelines with a new "Coding with AI" section detailing the acceptance of AI tools in contributions, requirements to disclose AI usage in PR descriptions, and best practices for reviewing AI-generated content.
    • Modified development workflow steps to remind contributors using AI tools to clearly disclose usage in their PR descriptions.

✏️ Tip: You can customize this high-level summary in your review settings.

@meili-bot meili-bot added the documentation Improvements or additions to documentation label Jan 19, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 19, 2026

📝 Walkthrough

Walkthrough

The CONTRIBUTING.md file is updated to introduce a new "Coding with AI" section that establishes guidelines for contributors using AI tools, requiring disclosure in pull request descriptions and providing guidance on documenting AI usage scope.

Changes

Cohort / File(s) Summary
Documentation Update
CONTRIBUTING.md
Added "Coding with AI" section outlining AI tool usage acceptance, disclosure requirements in PR descriptions, and guidance for documenting scope of AI-generated content. Modified step 5 in Development Workflow to remind contributors using AI tools to disclose this in their PR description.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A guidebook now glows with wisdom so bright,
AI tools welcomed with disclosure in sight,
Contributors share how their code came to be,
From human and machine, in harmony free! 🤖✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and accurately describes the main change: adding AI usage disclosure guidelines to CONTRIBUTING.md, which is the primary focus of the PR.
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.


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

🤖 Fix all issues with AI agents
In `@CONTRIBUTING.md`:
- Around line 5-10: Update the Table of Contents entry for the Release Process
so its link fragment matches the heading: replace the TOC line that currently
reads "- [Release Process (for internal team
only)](`#release-process-for-internal-team-only`)" with a line whose link text
matches the heading and whose anchor includes "the" — i.e. the visible text
"Release Process (for the internal team only)" and the fragment
"#release-process-for-the-internal-team-only" so the anchor and heading are
identical.

Comment on lines +5 to 10
- [Coding with AI](#coding-with-ai)
- [Assumptions](#assumptions)
- [How to Contribute](#how-to-contribute)
- [Development Workflow](#development-workflow)
- [Git Guidelines](#git-guidelines)
- [Release Process (for internal team only)](#release-process-for-internal-team-only)
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

# First, check the full CONTRIBUTING.md file to see TOC and headings
cat -n CONTRIBUTING.md | head -80

Repository: meilisearch/meilisearch-java

Length of output: 4937


🏁 Script executed:

# Try to run markdownlint
which markdownlint || echo "markdownlint not found in PATH"
markdownlint --version 2>/dev/null || echo "markdownlint not available"

Repository: meilisearch/meilisearch-java

Length of output: 190


🏁 Script executed:

# If markdownlint is not available, let's manually check for link fragment issues
# Extract TOC links and headings to compare
echo "=== TOC LINKS ===" 
sed -n '1,30p' CONTRIBUTING.md | grep -E '^\s*-\s+\[' 

echo -e "\n=== HEADINGS ===" 
grep -E '^#+\s' CONTRIBUTING.md | head -20

Repository: meilisearch/meilisearch-java

Length of output: 1171


Fix invalid link fragment on line 10

The TOC link #release-process-for-internal-team-only does not match the heading ## Release Process (for the internal team only). Change line 10 to:

- [Release Process (for the internal team only)](`#release-process-for-the-internal-team-only`)

The link fragment is missing "the" in the anchor.

🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

10-10: Link fragments should be valid

(MD051, link-fragments)

🤖 Prompt for AI Agents
In `@CONTRIBUTING.md` around lines 5 - 10, Update the Table of Contents entry for
the Release Process so its link fragment matches the heading: replace the TOC
line that currently reads "- [Release Process (for internal team
only)](`#release-process-for-internal-team-only`)" with a line whose link text
matches the heading and whose anchor includes "the" — i.e. the visible text
"Release Process (for the internal team only)" and the fragment
"#release-process-for-the-internal-team-only" so the anchor and heading are
identical.

@curquiza curquiza added this pull request to the merge queue Jan 19, 2026
Merged via the queue into main with commit 29801bd Jan 19, 2026
3 checks passed
@curquiza curquiza deleted the meili-bot/add-ai-disclosure-guidelines branch January 19, 2026 17:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants