Skip to content

Commit 722ef5f

Browse files
authored
Updating the templates to minimize checkboxes and use HTML comments. (google#1394)
1 parent ef14f0f commit 722ef5f

File tree

2 files changed

+78
-54
lines changed

2 files changed

+78
-54
lines changed

.github/ISSUE_TEMPLATE.md

+48-32
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,73 @@
1-
Thanks for opening an issue for us! Before you open an issue, please check if a similar issue exists or has been closed before.
2-
3-
If you're asking a question about how to use Blockly in your application, please ask questions on the [mailing list](https://groups.google.com/forum/#!forum/blockly) instead of filing issues.
4-
5-
_Please delete the above section and the instructions in the sections below before submitting. If a section is not applicable, type "N/A" in that section._
1+
<!--
2+
- Thanks for opening an issue for us! Before you open an issue,
3+
- please check if a similar issue exists or has been closed before.
4+
-
5+
- If you're asking a question about how to use Blockly in your application,
6+
- please ask questions on the mailing list, instead of filing issues:
7+
- https://groups.google.com/forum/#!forum/blockly
8+
-->
69

710
### Problem statement
811

9-
_Remove this hint: these checkboxes can be checked like this: [x]_
10-
11-
- [ ] Bug report
12-
- [ ] Feature request
13-
14-
_What were you trying to do when you hit this bug? Or, what do you want to do with Blockly that your proposed feature would enable?_
12+
<!-- TODO: Please describe the problem.
13+
- Is it a bug report (something didn't work the way you expected),
14+
- or a feature request (something new you think would improve Blockly)?
15+
-->
1516

1617
### Expected Behavior
1718

18-
_Please describe what should happen. Include screenshots if applicable._
19+
<!-- TODO: Please describe what should happen.
20+
- Include screenshots if applicable.
21+
-->
1922

2023
### Actual Behavior
2124

22-
_Describe what actually happens. Include screenshots if applicable._
25+
<!-- TODO: Describe what actually happens.
26+
- Include screenshots if applicable.
27+
-->
2328

2429
### Steps to Reproduce
2530

26-
_Explain what someone needs to do in order to see what's described in *Actual behavior* above_
31+
<!-- TODO: Explain what someone needs to do in order to see
32+
- what's described in *Actual behavior* above
33+
-->
34+
35+
1. Start by..
36+
2. Next, do..
2737

2838
### Stack Traces
2939

30-
```
31-
Please open up the console. If you see any Blockly-related errors, paste them here.
40+
<!-- TODO: Please open up the console. If you see any Blockly-related errors,
41+
- paste them between the quotes below.
42+
-
43+
- Ignore any instances of...
44+
- "Uncaught (in promise) DOMException: The play() request was interrupted by a call to pause()."
45+
-->
3246

33-
Ignore any instances of "Uncaught (in promise) DOMException: The play() request was interrupted by a call to pause()."
47+
```
48+
Replace with error stack trace.
3449
```
3550

3651
### Operating System and Browser
3752

38-
_Remove this hint: these checkboxes can be checked like this: [x]_
53+
<!-- TODO: If this issue is browser specific, uncomment the systems you have tested. -->
3954

40-
- [ ] Desktop:
41-
- [ ] Chrome
42-
- [ ] Firefox
43-
- [ ] Safari
44-
- [ ] Opera
45-
- [ ] IE 10+
46-
- [ ] IE 11
47-
- [ ] EDGE
55+
<!-- * Desktop Chrome -->
56+
<!-- * Desktop Firefox -->
57+
<!-- * Desktop Safari -->
58+
<!-- * Desktop Opera -->
59+
<!-- * Windows Internet Explorer 10 -->
60+
<!-- * Windows Internet Explorer 11 -->
61+
<!-- * Windows Edge -->
4862

49-
- [ ] Smartphone/Tablet/Chromebook (please complete the following information):
50-
- Device: [e.g. iPhone6]
51-
- OS: [e.g. iOS8.1]
52-
- Browser [e.g. stock browser, safari]
53-
- Version [e.g. 22]
63+
<!--
64+
* Smartphone/Tablet/Chromebook (please complete the following information):
65+
* Device: [e.g. iPhone6]
66+
* OS: [e.g. iOS8.1]
67+
* Browser [e.g. stock browser, safari]
68+
* Version [e.g. 22]
69+
-->
5470

5571
### Additional Information
5672

57-
_Anything else we should know?_
73+
<!-- Anything else we should know? -->

.github/PULL_REQUEST_TEMPLATE.md

+30-22
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,53 @@
1-
Thanks for submitting code to Blockly! Please fill out the following as part of your pull request so we can review your code more easily.
1+
<!--
2+
- Thanks for submitting code to Blockly! Please fill out the following as part of
3+
- your pull request so we can review your code more easily.
4+
-->
25

36
## The basics
47

8+
<!-- TODO: Verify the following, checking each box with an 'x' between the brackets: [x] -->
9+
510
- [ ] I branched from develop
611
- [ ] My pull request is against develop
712
- [ ] My code follows the [style guide](https://developers.google.com/blockly/guides/modify/web/style-guide)
813

914
## The details
1015
### Resolves
1116

12-
_What Github issue does this resolve (please include link)?_
17+
<!-- TODO: What Github issue does this resolve? Please include a link. -->
1318

1419
### Proposed Changes
1520

16-
_Describe what this Pull Request does. Include screenshots if applicable._
21+
<!-- TODO: Describe what this Pull Request does. Include screenshots if applicable. -->
1722

1823
### Reason for Changes
1924

20-
_Explain why these changes should be made. Include screenshots if applicable._
25+
<!--TODO: Explain why these changes should be made. Include screenshots if applicable. -->
2126

2227
### Test Coverage
2328

24-
_Please show how you have added tests to cover your changes, or tell us how you tested it and on which platforms._
29+
<!-- TODO: Please show how you have added tests to cover your changes,
30+
- or tell us how you tested it. For each systems you tested,
31+
- uncomment the systems in the list below.
32+
-->
2533

2634
Tested on:
27-
_Remove this hint: these checkboxes can be checked like this: [x]_
28-
- [ ] Desktop:
29-
- [ ] Chrome
30-
- [ ] Firefox
31-
- [ ] Safari
32-
- [ ] Opera
33-
- [ ] IE 10+
34-
- [ ] IE 11
35-
- [ ] EDGE
36-
37-
- [ ] Smartphone/Tablet/Chromebook (please complete the following information):
38-
- Device: [e.g. iPhone6]
39-
- OS: [e.g. iOS8.1]
40-
- Browser [e.g. stock browser, safari]
41-
- Version [e.g. 22]
42-
35+
<!-- * Desktop Chrome -->
36+
<!-- * Desktop Firefox -->
37+
<!-- * Desktop Safari -->
38+
<!-- * Desktop Opera -->
39+
<!-- * Windows Internet Explorer 10 -->
40+
<!-- * Windows Internet Explorer 11 -->
41+
<!-- * Windows Edge -->
42+
43+
<!--
44+
* Smartphone/Tablet/Chromebook (please complete the following information):
45+
* Device: [e.g. iPhone6]
46+
* OS: [e.g. iOS8.1]
47+
* Browser [e.g. stock browser, safari]
48+
* Version [e.g. 22]
49+
-->
50+
4351
### Additional Information
4452

45-
_Anything else we should know?_
53+
<!-- Anything else we should know? -->

0 commit comments

Comments
 (0)