Skip to content

Update AGENTS.md to avoid AI bloat - #1235

Merged
shanjiaz merged 6 commits into
mainfrom
orestis-z-patch-1
Oct 14, 2026
Merged

shanjiaz merged 6 commits into
mainfrom
orestis-z-patch-1

Conversation

@orestis-z

@orestis-z orestis-z commented Oct 14, 2026 •

Copy link
Copy Markdown
Collaborator

Purpose

Agents contributing to this repo write bloated PR descriptions and tick the "a human reviewed this" checkbox on the author's behalf. AGENTS.md said nothing about any of it. This adds a Pull requests section that does — the author-side counterpart to the AI slop check already in .claude/skills/pr-review/SKILL.md.

Tests

Docs only. pre-commit run --all-files passes (mdformat).

Checklist

I have filled in:

  • The purpose of the PR, such as "Fix some issue (link existing issues this PR will resolve)".
  • The test plan/results, such as providing test command and pasting the results.
  • (Optional) The necessary documentation update.
  • I (a human) have written or reviewed the code in this pr to the best of my ability.

@orestis-z orestis-z self-assigned this Oct 14, 2026
@coderabbitai

coderabbitai Bot commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration
  • Configuration used: Repository: vllm-project/speculators/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: add4a771-1b32-45d7-9bde-ca762fc57950

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: vllm-project/speculators/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 21fee302-97ac-4a36-b73e-ab3f608ac177
📥 Commits

Reviewing files that changed from the base of the PR and between 613257e and bed999a.

📒 Files selected for processing: 1
  • AGENTS.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

📝 Walkthrough

AGENTS.md adds guidance for contribution setup and pull-request preparation. It describes required PR-template content, verification and style constraints, and the authorship checkbox.

Changes: Pull-request guidance

Layer / File(s) Summary
Contribution and pull-request instructions
AGENTS.md
Adds instructions to read CONTRIBUTING.md, install pre-commit hooks after installing the [dev] extras, complete the PR template’s Purpose and Tests sections, avoid specified misleading or disallowed content, and leave the human-authorship checkbox unchecked.

Priority: ⬇️ Low

Merge Risk: ⚪ Minimal · up to bed99

The new contributor guidance matches the repository’s setup instructions and PR template; no actionable merge risk remains.

Pre-merge checks: Passed 5
Passed Passed checks: 5 passed
Check name Status Explanation
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Title check Passed The title clearly identifies the updated file and the purpose of reducing bloated AI-generated pull request content.
Description check Passed The description directly explains the documentation changes, their purpose, and the reported test result.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

@mergify mergify Bot added the documentation Improvements or additions to documentation label Oct 14, 2026
@mergify

mergify Bot commented Oct 14, 2026 •

Copy link
Copy Markdown

Merge Protections

🟢 Merge protection satisfied — ready to merge.

Show 1 satisfied protection

🟢 Require approval from approved reviewers list

All pull requests must have at least one approving review from a member of the approved reviewers list before merging.

  • any of:
    • approved-reviews-by = shanjiaz
    • approved-reviews-by = dsikka
    • approved-reviews-by = fynnsu
    • approved-reviews-by = orestis-z
    • approved-reviews-by = rahul-tuli

Tell agents what a good PR on this repo looks like: install the git
hooks, fill in Purpose and Tests, keep them short, don't fabricate test
output, and don't tick the "a human reviewed this" checkbox on the
author's behalf.

Author-side counterpart to the AI slop check in the pr-review skill.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Signed-off-by: Orestis Zambounis <orestis.zambounis@gmail.com>
Signed-off-by: Orestis Zambounis <23146389+orestis-z@users.noreply.github.com>
Signed-off-by: Orestis Zambounis <23146389+orestis-z@users.noreply.github.com>
Signed-off-by: Orestis Zambounis <orestis.zambounis@gmail.com>
Signed-off-by: Orestis Zambounis <23146389+orestis-z@users.noreply.github.com>
@orestis-z
orestis-z marked this pull request as ready for review October 14, 2026 15:03
@orestis-z orestis-z changed the title Update AGENTS.md Update AGENTS.md to avoid AI bloat Oct 14, 2026
Comment thread AGENTS.md Outdated
Signed-off-by: Orestis Zambounis <23146389+orestis-z@users.noreply.github.com>

@shanjiaz shanjiaz left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks for adding this!

@shanjiaz shanjiaz added the ready This PR is ready for review label Oct 14, 2026
@shanjiaz
shanjiaz enabled auto-merge (squash) October 14, 2026 15:13
@github-actions

Copy link
Copy Markdown

Link Check Results (DOCS)

Summary

Status Count
🔍 Total 251
🔗 Unique 150
✅ Successful 246
⏳ Timeouts 0
🔀 Redirected 5
👻 Excluded 1
❓ Unknown 0
🚫 Errors 4
⛔ Unsupported 0

Errors per input

Errors in docs/user_guide/tutorials/train.md

Redirects per input

Redirects in docs/community/contact_us.md

Redirects in docs/community/index.md

Redirects in docs/index.md

Redirects in docs/user_guide/algorithms/dspark.md

Full Github Actions output


Last updated: b0a581d

@shanjiaz
shanjiaz merged commit c5d4f9d into main Oct 14, 2026
10 of 11 checks passed
@shanjiaz
shanjiaz deleted the orestis-z-patch-1 branch October 14, 2026 15:27
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 ready This PR is ready for review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants