Add AI usage disclosure guidelines to CONTRIBUTING.md#925
Conversation
📝 WalkthroughWalkthroughThe 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
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ 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. Comment |
There was a problem hiding this comment.
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.
| - [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) |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# First, check the full CONTRIBUTING.md file to see TOC and headings
cat -n CONTRIBUTING.md | head -80Repository: 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 -20Repository: 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.
This PR is auto-generated.
This PR adds guidelines about AI tool usage in contributions:
Our policy: AI usage is accepted, provided contributors disclose it in their PR description. This transparency helps maintainers during code review.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.