Boosting Software Development Efficiency: Preventing Lost GitHub Review Drafts

In the fast-paced world of software development, efficient collaboration and clear communication are paramount. Code reviews are a cornerstone of this process, ensuring quality and knowledge sharing. However, a recent discussion in the GitHub Community highlights a subtle yet significant bug that could silently undermine a developer's efforts and impact overall software development efficiency.

The Case of the Disappearing Review Draft

A user, parichay28, brought to light an issue where a pending pull request review body, meticulously crafted and set via the GitHub REST API, is not displayed in the UI's "Finish your review" dialog. Worse still, if a user proceeds to submit the review from the UI without manually re-entering text, the original API-set body is silently overwritten with an empty string.

The Problem: API-Set Body Overwritten

The GitHub API documentation states that omitting the event parameter when creating a review keeps it "pending," allowing users to "finalize it later" in the UI. This naturally implies that any body text provided should be preserved and displayed as a draft. However, this is not the case. Developers using the API to pre-populate review summaries – perhaps as part of an automated process or a custom tool to enhance developer productivity – find their work discarded.

Steps to Reproduce the Bug:

1. Create a pending review via API: Use the GitHub REST API to create a pending review with a non-empty body. The key is to omit the event parameter to keep it in a draft state.

   curl -X POST \
   -H "Authorization: Bearer " \
   -H "Accept: application/vnd.github+json" \
   https://api.github.com/repos///pulls//reviews \
   -d '{"body": "My review summary."}'

2. Access the PR in the UI: Navigate to the "Files changed" tab of the relevant Pull Request on GitHub.
3. Initiate Review Submission: Click the "Review changes" button.
4. Observe Empty Textarea: The "Finish your review" dialog appears, but the textarea for the review body is unexpectedly empty, not containing "My review summary."
5. Silent Overwrite: If the user submits the review at this point without typing anything into the empty textarea, the original API-set body is permanently overwritten with an empty string.

What the User Sees (and Loses):

The underlying issue is that the UI's submission process sends an empty body if the textarea is untouched, without falling back to the saved draft. This leads to a state change like this:

• Before: { "state": "PENDING", "body": "My review summary." }
• After: { "state": "COMMENTED", "body": "" }

Impact on Developer Productivity

This bug can lead to frustration and wasted effort. If a team relies on tools that pre-populate review summaries or if a developer starts a review via API and intends to finish it later, this silent overwrite means valuable context or feedback is lost. It forces developers to either re-type their summary or be extremely cautious, adding friction to the code review process and hindering overall software development efficiency.

Suggested Fix

The proposed solution is straightforward and logical: the "Finish your review" dialog should pre-populate its textarea with the saved body of the pending review when it opens. This would align the UI behavior with the implied functionality of the API, ensuring continuity and preventing data loss.

While GitHub's automated response acknowledged the feedback, the community awaits a resolution to this usability hiccup. Ensuring that API-driven workflows integrate seamlessly with the UI is crucial for maintaining high levels of developer productivity and trust in platform capabilities.