Update issue templates #27570
Merged
Update issue templates #27570
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
noisysocks
added
the
[Type] Project Management
noisysocks
commented
Dec 8, 2020
.github/ISSUE_TEMPLATE/Bug_report.md
Outdated
Comment on lines
8
to
15
| Please fill out ALL sections. Bug reports with missing information will be | ||
| closed. | ||
|
|
||
| **To reproduce** | ||
| Steps to reproduce the behavior: | ||
| Before submitting a bug report: | ||
|
|
||
| - Check if the bug has already been fixed by updating WordPress and/or Gutenberg. | ||
| - Check if the bug is caused by a plugin by deactivating all plugins except Gutenberg. | ||
| - Check if the bug is caused by a theme by activating a default theme e.g. Twenty Twenty. |
There was a problem hiding this comment.
This preamble is intended to encourage the reporter to do a little upfront investigation. This makes bug reports easier to reproduce, triage, and eventually fix.
noisysocks
commented
Dec 8, 2020
.github/ISSUE_TEMPLATE/Bug_report.md
Outdated
Comment on lines
38
to
44
| **Screenshots or screen recording (optional)** | ||
| <!-- | ||
| If possible, please upload a screenshot or screen recording which demonstrates | ||
| the bug. You can use LIEcap to create a GIF screen recording: | ||
| https://www.cockos.com/licecap/ | ||
| --> |
There was a problem hiding this comment.
Uploading a GIF screen recording helps a lot with triaging, so we should try to encourage it. LICEcap is free and open source software.
There was a problem hiding this comment.
I use Kap, which is also free and open source, and built with web technology 😆
There was a problem hiding this comment.
(Rephrasing above sentence.)
You can use LIEcap https://www.cockos.com/licecap/ or Kap https://getkap.co/ or any other GIF screen recording software.
There was a problem hiding this comment.
Does Kap work on Windows?
There was a problem hiding this comment.
From looking at kap web site it looks like Mac only software.
I went ahead and asked them if they have plans to add a version for Windows PC's: wulkano/Kap#969
There was a problem hiding this comment.
Here is another program I have heard a mention of earlier. Which works on Mac and Windows.
https://monosnap.com/welcome
noisysocks
commented
Dec 8, 2020
noisysocks
commented
Dec 8, 2020
noisysocks
commented
Dec 8, 2020
.github/ISSUE_TEMPLATE/Bug_report.md
Outdated
Comment on lines
56
to
57
| - Are all plugins except Gutenberg deactivated? <!-- "Yes" or "No" --> | ||
| - Are you using a default theme (e.g. Twenty Twenty)? <!-- "Yes" or "No" --> |
There was a problem hiding this comment.
Similar to the preamble. This little bit of upfront investigation helps with reproducing, triaging, and fixing.
noisysocks
commented
Dec 8, 2020
noisysocks
commented
Dec 8, 2020
noisysocks
commented
Dec 8, 2020
|
Size Change: 0 B Total Size: 1.3 MB ℹ️ View Unchanged
|
talldan
reviewed
Dec 9, 2020
talldan
reviewed
Dec 9, 2020
talldan
reviewed
Dec 10, 2020
|
All comments addressed. I reckon this is good to go. What do you think? |
kevin940726
reviewed
Jan 5, 2021
|
Other than @kevin940726 quick feedback above, I think this is good to go! |
paaljoachim
reviewed
Jan 5, 2021
paaljoachim
reviewed
Jan 5, 2021
paaljoachim
reviewed
Jan 5, 2021
paaljoachim
reviewed
Jan 5, 2021
paaljoachim
reviewed
Jan 5, 2021
|
@paaljoachim: I just removed the preamble about feature requests altogether. It's a difficult conversation to have in this limited format, so let's stick to having maintainers ask these questions for now. |
|
I reworded those headings cc. @paaljoachim. |
kevin940726
approved these changes
Jan 7, 2021
noisysocks
force-pushed
the
update/issue-templates
branch
from
5b1bf52 to
9978c5b
Compare
Update the GitHub issue templates so that they are clearer and encourage better bug reports.
noisysocks
force-pushed
the
update/issue-templates
branch
from
9978c5b to
84ada01
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@annezazu and I had a crack at updating the issue templates that we use in the Gutenberg GitHub repository.
I'll explain some of the choices using inline review comments.
https://docs.github.com/en/free-pro-team@latest/github/building-a-strong-community/configuring-issue-templates-for-your-repository