Spaces:
Sleeping
Sleeping
Petr Tsvetkov
commited on
Commit
·
2065aab
1
Parent(s):
f2afbff
Add examples to the survey guide; fix the verbosity question 50 make "5" a positive grade
Browse files- app.py +2 -1
- survey_guide.md +37 -2
app.py
CHANGED
@@ -176,7 +176,8 @@ with gr.Blocks(theme=gr.themes.Soft(), head=head_html, css="style_overrides.css"
|
|
176 |
# interactive=True))
|
177 |
|
178 |
model_questions.append(gr.Radio(
|
179 |
-
info='The commit message
|
|
|
180 |
label=f'is_not_verbose',
|
181 |
show_label=False,
|
182 |
choices=SCALE,
|
|
|
176 |
# interactive=True))
|
177 |
|
178 |
model_questions.append(gr.Radio(
|
179 |
+
info='The commit message cannot be substantially shortened without loss of important '
|
180 |
+
'information.',
|
181 |
label=f'is_not_verbose',
|
182 |
show_label=False,
|
183 |
choices=SCALE,
|
survey_guide.md
CHANGED
@@ -8,14 +8,49 @@ 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
|
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 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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.*
|
|
|
8 |
code changes, as well as five questions about the commit
|
9 |
message.
|
10 |
|
11 |
+
In the first three 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 |
+
Here are some examples of the responses expected for
|
16 |
+
some commit messages:
|
17 |
+
|
18 |
+
**Code changes: change the color of button from green
|
19 |
+
to blue in the file.py python file.**
|
20 |
+
|
21 |
+
**The information provided in the commit message is consistent
|
22 |
+
with the code changes.** <br>
|
23 |
+
1 (strongly disagree): _"fix: change the background color
|
24 |
+
from white to yellow"_ <br>
|
25 |
+
5 (strongly agree): _"change the color of the button from green
|
26 |
+
to blue"_
|
27 |
+
|
28 |
+
**The commit message cannot be substantially shortened without
|
29 |
+
loss of important information.** <br>
|
30 |
+
1 (strongly disagree): _"Update slider color in file.py
|
31 |
+
<br><br>
|
32 |
+
The button color in the application Python file (file.py)
|
33 |
+
was changed from green to blue. The color has been changed
|
34 |
+
to blue to improve visibility or provide a more
|
35 |
+
user-friendly UI. This change is purely cosmetic and does
|
36 |
+
not affect the functionality of the software."_ <br>
|
37 |
+
5 (strongly agree): _"change the color of the button"_
|
38 |
+
|
39 |
+
**The commit message is easy to read and to understand.**
|
40 |
+
1 (strongly disagree): _"Alter the hue of the interactive
|
41 |
+
clickable element transitioning from the shade likened
|
42 |
+
to that of fresh grass towards that of the clear midday
|
43 |
+
sky"_ <br>
|
44 |
+
5 (strongly agree): _"feat: Update button color from
|
45 |
+
green to blue in file.py"_
|
46 |
+
|
47 |
+
In the fourth question, you are asked to state your overall
|
48 |
impression of the commit message (from 1 - the message is very
|
49 |
low quality, to 5 - the message is perfect).
|
50 |
|
51 |
+
In the last question, you can leave an additional text
|
52 |
+
comment about the commit message. _This question is optional._
|
53 |
+
|
54 |
After completing the form for one of the commit message
|
55 |
variants, submit it using the button below. *The corresponding
|
56 |
form should be submitted separately for each message variant.*
|