Skip to content

Update pull request commenting instructions and screenshot - #45815

Open
ashis-baral wants to merge 3 commits into
github:mainfrom
ashis-baral:comment-on-pr
Open

Update pull request commenting instructions and screenshot#45815
ashis-baral wants to merge 3 commits into
github:mainfrom
ashis-baral:comment-on-pr

Conversation

@ashis-baral

@ashis-baral ashis-baral commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Why:

fix: #45814

What's being changed (if available, include any code snippets, screenshots, or gifs):

This PR updates the pull request commenting documentation to match the current GitHub UI.

The following changes are being made:

  • Update Add single comment to Comment because the current UI uses the Comment button when submitting an individual comment.

  • Update Finish your review to Submit review to match the current UI.

  • Update the outdated screenshot. The current screenshot shows the old Add a single comment button, while the current GitHub UI shows Comment.

suggestion-block

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing and the changes look good in the review environment.

Updated wording for commenting options and review submission.
@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label Sep 9, 2026
@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

How to review these changes 👓

Thank you for your contribution. To review these changes, choose one of the following options:

A Hubber will need to deploy your changes internally to review.

Table of review links

Note: Please update the URL for your staging server or codespace.

The table shows the files in the content directory that were changed in this pull request. This helps you review your changes on a staging server. Changes to the data directory are not included in this table.

Source Review Production What Changed
pull-requests/how-tos/review-pull-requests/commenting-on-a-pull-request.md fpt
ghec
ghes@ 3.22 3.21 3.20 3.19 3.18 3.17
fpt
ghec
ghes@ 3.22 3.21 3.20 3.19 3.18 3.17

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server

🤖 This comment is automatically generated.

@subatoi subatoi 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.

Hi again @ashis-baral, your changes are correct for FPT/GHEC, but the original text is still true for GHES. Would you be OK adding versioning to that effect? Many thanks

@subatoi subatoi added content This issue or pull request belongs to the Docs Content team Waiting on contributor and removed triage Do not begin working on this issue until triaged by the team labels Sep 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content This issue or pull request belongs to the Docs Content team Waiting on contributor

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Incorrect button names in pull request commenting instructions

3 participants