Skip to content

Improve PR review instructions #334

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
eshulman2 merged 1 commit into from
Sep 1, 2026
Merged

Improve PR review instructions #334

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions src/forge/workflow/nodes/pr_creation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,12 +343,15 @@ async def _post_pr_commands_comment(
"""Post informational PR commands comment on a newly created pull request."""
try:
comment_body = (
"### 🛠️ Forge PR Commands\n\n"
"This pull request was created by Forge! You can use the following commands by commenting on this PR:\n\n"
"### 🤖 Reviewing a Forge pull request\n\n"
"To send code feedback to Forge, open **Files changed**, select "
"**Review changes**, and submit a **Request changes** review. Forge will "
"address the review feedback automatically and push updates to this pull request.\n\n"
"Regular comments are ignored by the review workflow. Use them for conversation "
"or the Forge commands below:\n\n"
"* `/forge rebase` - Merge the base branch (e.g. `main`) into this PR branch, with conflicts resolved by AI.\n"
"* `/forge skip-gate <name>` - Skip a named CI check (substring match) for this PR. This setting persists across subsequent pushes.\n"
"* `/forge unskip-gate <name>` - Remove a previously set CI check skip.\n\n"
"Feel free to use these commands to manage your workflow!"
"* `/forge unskip-gate <name>` - Remove a previously set CI check skip."
)
await adapter.create_comment(repo_ref, identity_for(repo_ref, pr_number), comment_body)
logger.info(f"Posted informational command comment on newly created PR #{pr_number}")
Expand Down
4 changes: 4 additions & 0 deletions tests/unit/workflow/nodes/test_pr_creation_informational_comment.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,10 @@ async def test_posts_comment_on_new_pr(self):
mock_adapter.create_comment.assert_awaited_once()
call_args = mock_adapter.create_comment.call_args[0]
assert call_args[1].native_id == 456
assert "**Review changes**" in call_args[2]
assert "**Request changes**" in call_args[2]
assert "address the review feedback automatically" in call_args[2]
assert "Regular comments are ignored by the review workflow" in call_args[2]
assert "/forge rebase" in call_args[2]
assert "/forge skip-gate" in call_args[2]
assert "/forge unskip-gate" in call_args[2]
Expand Down
Loading