commit-message-editing / survey_guide.md
Petr Tsvetkov
In the survey guide, ask participants to not copy-paste summary to the commit message.
64ddd9b
|
raw
history blame
1.23 kB

Thank you for agreeing to take part!

In this study, we study how developers interact with commit message text generated by a LLM. Imagine that you are in the IDE and writing a commit message (the changes to the code are shown on the left). You have generated a message using a LLM. You can see this generated message on the top right. However, the message will not necessarily be perfect!

Now, you need to edit the commit message so that it is good enough to publish to VCS. Please do this directly in the text box. When you're done, press the "Submit" button: you will proceed to the next commit and the next generated message. Please repeat the process for as many commits as you can. If you are stuck on some commit, feel free to skip it using the button on the top right.

We understand that the repositories and the commits we show may be unfamiliar to you. In order to help, we used a LLM to generate a summary of the commit - you can see the summary by opening the dropdown right above the commit message edit field. Please, do not copy-paste anything from this summary into the commit message.

During the study, we collect all keystrokes made in a text window, as well as the resulting message.