Petr Tsvetkov commited on
Commit
f2afbff
·
1 Parent(s): f06961e

Help accordion added

Browse files
Files changed (2) hide show
  1. app.py +5 -0
  2. survey_guide.md +28 -0
app.py CHANGED
@@ -104,6 +104,11 @@ with gr.Blocks(theme=gr.themes.Soft(), head=head_html, css="style_overrides.css"
104
  hash_val = gr.Textbox(interactive=False, label='hash', visible=False)
105
  shuffled_idx_val = gr.JSON(visible=False)
106
 
 
 
 
 
 
107
  with gr.Row():
108
  current_sample_sld = gr.Slider(minimum=0, maximum=n_samples, step=1,
109
  value=0,
 
104
  hash_val = gr.Textbox(interactive=False, label='hash', visible=False)
105
  shuffled_idx_val = gr.JSON(visible=False)
106
 
107
+ with gr.Row():
108
+ with gr.Accordion("Help"):
109
+ with open("survey_guide.md") as content_file:
110
+ gr.Markdown(content_file.read())
111
+
112
  with gr.Row():
113
  current_sample_sld = gr.Slider(minimum=0, maximum=n_samples, step=1,
114
  value=0,
survey_guide.md ADDED
@@ -0,0 +1,28 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ **Thank you for agreeing to take part!**
2
+
3
+ In this study, you will be asked to look at some commits
4
+ and evaluate different variants of corresponding commit
5
+ messages. On the right, you can see the code changes
6
+ included in the commit. On the left, there are tabs, each
7
+ containing a variant of a commit message describing the
8
+ code changes, as well as five questions about the commit
9
+ message.
10
+
11
+ In the first four questions, you are given a statement about
12
+ the commit message and asked to state your level of agreement
13
+ with it - from 1 (strongly disagree) to 5 (strongly agree).
14
+
15
+ In the last question, you are asked to state your overall
16
+ impression of the commit message (from 1 - the message is very
17
+ low quality, to 5 - the message is perfect).
18
+
19
+ After completing the form for one of the commit message
20
+ variants, submit it using the button below. *The corresponding
21
+ form should be submitted separately for each message variant.*
22
+ After submitting all forms, you can move on to the next
23
+ commit message by pressing the bottom button.
24
+
25
+ If, for some reason, you do not want to submit one or more
26
+ forms for the current commit, you can skip it and continue
27
+ to the next commit by pressing the "Skip the current sample"
28
+ button in the upper right corner.