Don't ask for feature detection cleanup comments when not needed - #14139
Merged
babakks merged 2 commits intoAug 13, 2026
Conversation
Clarified usage of cleanup comments for API features
Contributor
There was a problem hiding this comment.
Pull request overview
Clarifies when feature-detection cleanup comments are appropriate.
Changes:
- Exempts capabilities not planned for GHES from cleanup TODOs.
Show a summary per file
| File | Description |
|---|---|
AGENTS.md |
Updates feature-detection guidance. |
Review details
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Balanced
|
|
||
| Use feature detection only when an API is not GA on all supported GHES versions; skip it for long-established APIs. | ||
|
|
||
| Note that a cleanup comment is only needed when a feature will eventually be available on all GitHub API server (i.e. `github.com`, GHEC, and GHES). Those that are not going to be supported on GHES should not have a cleanup comment. |
Member
Author
There was a problem hiding this comment.
@copilot Fix the code for this review comment.
When a review comment includes a suggested change, apply the suggestion exactly.
Do not make changes beyond what is described in the linked review comment.
Contributor
There was a problem hiding this comment.
Fixed in 508510f - merged the two rules into one consistent statement: the cleanup TODO is required for temporary gates and not needed for permanent GHES-excluded gates.
Co-authored-by: babakks <36728931+babakks@users.noreply.github.com>
BagToad
approved these changes
Aug 13, 2026
babakks
enabled auto-merge
August 13, 2026 14:52
babakks
deleted the
babakks/no-cleanup-comment-for-dotcom-only-features
branch
August 13, 2026 15:01
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This change is due to the misleading comment on another PR review (#14006 (comment)) where
was asking for a cleanup comment on a feature detection conditional, while it didn't make sense because the feature would never be shipped to GHES.
How did you test this change?
N/A
Key points
N/A
Notes for reviewers
N/A
Authorship and follow-up
Who wrote this:
Who answers review comments: