quick_replies.rst 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. Quick replies
  2. =============
  3. Quick replies are reusable pieces of text that you can use to start a comment
  4. on an issue or pull request. They are meant to remove the hassle of typing a
  5. similar response again and again.
  6. Examples where this can be handy:
  7. * asking for a rebase of a pull request
  8. * asking a person to add a ``Signed-off-by`` line to their commit
  9. All these requests might be accompanied by a description on why it's requested.
  10. With quick replies you can prepare the descriptions and the just use them with
  11. a click of a button.
  12. Using quick replies
  13. -------------------
  14. Any user that can comment will be able to use the quick reply. They are offered
  15. in a drop down menu next to the *Preview* button above comment form.
  16. .. image:: /_static/quick_replies.png
  17. The button is only visible if the project has some quick replies defined.
  18. Additionally, the button will become insensitive when you type something into
  19. the comment box or switch to preview. This should avoid writing over your
  20. carefully crafted comment by accident. If you remove the text from the field,
  21. the button will work again.
  22. Creating and modifying quick replies
  23. ------------------------------------
  24. Project admins can create them in the settings section. There are no length
  25. limits on the reply, but only the first 50 characters will be displayed in the
  26. menu for users to choose from. This limitation should encourage you to put the
  27. most important message at the beginning.
  28. The order in which you define the replies will be preserved on the chooser
  29. menu. This can be used to put the most frequently used ones on the top of the
  30. list.