Skip to content

add backend instructions #2090

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.

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
merged 1 commit into from
Aug 19, 2025
Merged

Conversation

breardon2011
Copy link
Contributor

@breardon2011 breardon2011 commented Aug 19, 2025

Screenshot 2025-08-18 at 6 01 41 PM

@breardon2011 breardon2011 marked this pull request as ready for review August 19, 2025 01:02
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

Greptile Summary

This PR enhances the backend's comment generation functionality by adding instruction helpers to PR comments. The change introduces a new formatExampleCommands() function that creates a collapsible markdown section containing example digger apply and digger unlock commands. This function is then integrated into the existing GenerateRealtimeCommentMessage() function to append these instructions after the main table content.

The implementation directly addresses a consistency gap between the CLI and backend comment formats. Previously, the CLI's BasicCommentUpdater included helpful instruction sections in PR comments, while the backend's comment generation lacked these user guidance features. The new functionality uses the exact same markdown structure and command examples as the CLI implementation, ensuring a uniform user experience across all Digger-generated comments.

The instructions are strategically placed after the main table but before the comment length validation, ensuring visibility while respecting GitHub's comment length constraints. This change fits into the broader comment utility system that manages PR interactions and helps users understand available actions directly within their pull request workflow.

Confidence score: 4/5

  • This PR is safe to merge with minimal risk as it only adds instructional content to existing comments
  • Score reflects simple, additive changes that enhance user experience without modifying core functionality
  • No files require special attention as the changes are straightforward and well-contained

1 file reviewed, no comments

Edit Code Review Bot Settings | Greptile

Copy link
Contributor

bismuthdev bot commented Aug 19, 2025

Bismuth completed its review and found no issues.

@motatoes motatoes merged commit 413a1d4 into develop Aug 19, 2025
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants