Skip to content

For the complete documentation index, see llms.txt.

Give feedback on a suggestion

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:

SituationMethod
You want one or more changes across the suggestionRequest changes
Your feedback is about specific lines in a fileComment on lines
Your feedback is about the whole suggestion, or you want a teammate’s inputLeave an overall comment
The suggestion shouldn’t be publishedClose it with feedback
You review in GitHub or GitLab, and the docs PR is openComment 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.

  • An Editor or Admin role in your Promptless organization, to request changes or close a suggestion. Any member can comment.

Use Request Changes when you want Promptless to revise the suggestion, especially when you have several changes to ask for at once.

  1. On the suggestion, select Request Changes.

  2. Describe every change you want. Promptless addresses them together.

  3. Select Submit Request.

A suggestion in the Promptless dashboard with Request Changes expanded, showing an empty text field for describing the changes

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.”

Use a line comment when your feedback is about a specific passage.

  1. 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.

  2. Select Add comment or request changes, or press ⌘M (Ctrl+M on Windows and Linux).

  3. Enter your comment.

  4. Optional. To keep Promptless from acting on the comment, clear Send to Promptless.

  5. 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.

Use an overall comment for feedback that applies to the whole suggestion, or to bring a teammate into the review.

  1. On the suggestion, enter your comment under Discussions.

  2. Optional. To pull in a teammate, mention them. A mention notifies that person whether or not you send the comment to Promptless.

  3. Optional. To keep Promptless from acting on the comment, clear Send to Promptless.

  4. Select Post comment.

Close a suggestion when it shouldn’t be published. Closing doesn’t change the suggestion, but your reasons tell Promptless why it missed.

  1. On the suggestion, select Close Suggestion.

  2. 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

  3. 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.”

  4. Leave Send to Promptless checked so Promptless reads your reasons and feedback. The checkbox is available once you select a reason or enter feedback.

  5. Select Close Suggestion.

A suggestion in the Promptless dashboard with Close Suggestion expanded, listing close reasons as checkboxes

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.