Give feedback on a suggestion
Overview
Section titled “Overview”Feedback on a suggestion tells Promptless what to change before you publish it. Choose a method by what your feedback covers and where you’re reviewing:
| Situation | Method |
|---|---|
| You want one or more changes across the suggestion | Request changes |
| Your feedback is about specific lines in a file | Comment on lines |
| Your feedback is about the whole suggestion, or you want a teammate’s input | Leave an overall comment |
| The suggestion shouldn’t be published | Close it with feedback |
| You review in GitHub or GitLab, and the docs PR is open | Comment on the docs PR |
Feedback on one suggestion changes only that suggestion. To have Promptless apply a rule to every future suggestion as well, state it as a standing rule. See Teach conventions with feedback.
Before you start
Section titled “Before you start”- An Editor or Admin role in your Promptless organization, to request changes or close a suggestion. Any member can comment.
Request changes
Section titled “Request changes”Use Request Changes when you want Promptless to revise the suggestion, especially when you have several changes to ask for at once.
-
On the suggestion, select Request Changes.
-
Describe every change you want. Promptless addresses them together.
-
Select Submit Request.
For example:
- “Put X file’s content as a section in Y file instead of making it its own file.”
- “Make the tone more conversational, and do that for all future suggestions too.”
- “I always want changelog entries in their own suggestion. Please move.”
Comment on lines
Section titled “Comment on lines”Use a line comment when your feedback is about a specific passage.
-
In a file’s diff, select the text, or select a line number to select the whole line. If you’ve edited the file, save your edits first.
-
Select Add comment or request changes, or press ⌘M (Ctrl+M on Windows and Linux).
-
Enter your comment.
-
Optional. To keep Promptless from acting on the comment, clear Send to Promptless.
-
Post the comment.
Once the suggestion has a docs PR, Promptless also posts your line comments and replies to the PR. That includes comments you didn’t send to Promptless. Replies left on the PR appear in the dashboard thread.
Leave an overall comment
Section titled “Leave an overall comment”Use an overall comment for feedback that applies to the whole suggestion, or to bring a teammate into the review.
-
On the suggestion, enter your comment under Discussions.
-
Optional. To pull in a teammate, mention them. A mention notifies that person whether or not you send the comment to Promptless.
-
Optional. To keep Promptless from acting on the comment, clear Send to Promptless.
-
Select Post comment.
Close a suggestion with feedback
Section titled “Close a suggestion with feedback”Close a suggestion when it shouldn’t be published. Closing doesn’t change the suggestion, but your reasons tell Promptless why it missed.
-
On the suggestion, select Close Suggestion.
-
Optional. Select one or more reasons:
-
I copied this change into my docs editor
-
This change is incorrect
-
This change is too insignificant
-
This change was covered in another Promptless suggestion
-
This is already in my docs
-
This change is self-explanatory and doesn’t need docs
-
-
Optional. In Additional feedback (optional), explain what was wrong. To have Promptless skip similar changes in the future, say so here, for example “Don’t create suggestions for dependency bumps.”
-
Leave Send to Promptless checked so Promptless reads your reasons and feedback. The checkbox is available once you select a reason or enter feedback.
-
Select Close Suggestion.
Comment on the docs PR
Section titled “Comment on the docs PR”Once Promptless opens the docs PR, you can review it in GitHub or GitLab like any other pull request. Leave line comments, or submit a review to send several comments at once. Whether Promptless acts on a comment without an @promptless mention depends on your organization’s comment setting. See Talk to Promptless without a mention.
See also
Section titled “See also”- Teach conventions with feedback, to make Promptless apply a rule to every future suggestion
- Review and edit Promptless PRs, for reviewing in the dashboard and steering the docs PR from comments
- Review from Slack and Teams, to refine a suggestion from the thread it came from
- Filter noise and tune relevance, when the same kind of suggestion keeps getting closed