github: Configure templates for filing issues. #26000
Merged
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
alya
added
the
priority integration review
timabbott
force-pushed
the
reporting-bugs-continued
branch
from
dee98f4
to
188f8e5
Compare
timabbott
added
the
backport candidate
timabbott
force-pushed
the
reporting-bugs-continued
branch
3 times, most recently
from
3622754
to
21b4db2
Compare
This PR creates templates for filing issues. The templates are intentionally quite light-weight. Note that I'm specifically not using forms for creating issues, as the UI for filling out such a form does not include GitHub's helpful formatting buttons and preview mode. Follow-up to zulip#25998, pushed as a separate PR so that the original one can pass CI. This PR creates templates for filing issues. The templates are intentionally quite light-weight. Note that I'm specifically not using forms for creating issues, as the UI for filling out such a form does not include GitHub's helpful formatting buttons and preview mode. A major goal is to guide users towards starting a CZO conversation when that's more appropriate than filing a GitHub issue. Note that the config makes it possible to create a blank issue, which should be handy for: * Issues filed by maintainers * Issues for tracking follow-ups from merged PRs * Probably some other situations Because the blank issue option is easy to miss, it should probably be documented somewhere, but I'm not sure where. We can perhaps start with a note on CZO. Relevant CZO threads: https://chat.zulip.org/#narrow/stream/137-feedback/topic/issues.20link.20in.20description/near/1561110) https://chat.zulip.org/#narrow/stream/2-general/topic/bug.20report.20management/near/1589141 Also provide external documentation links for situations where filing an issue is not the best approach.
timabbott
force-pushed
the
reporting-bugs-continued
branch
from
21b4db2
to
22af2b4
Compare
|
With the tweaks we did just now, this looks good to me. Merging, though of course because issue templates don't seem to have a preview mode :), we may need to make some further changes after testing it. |
alexmv
removed
the
backport candidate
18 tasks
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.
Follow-up to #25998, pushed as a separate PR so that the original one can pass CI.
This PR creates templates for filing issues. The templates are intentionally quite light-weight. Note that I'm specifically not using forms for creating issues, as the UI for filling out such a form does not include GitHub's helpful formatting buttons and preview mode.
More importantly, users will be presented with the following options when creating an issue:
A major goal is to guide users towards starting a CZO conversation when that's more appropriate than filing a GitHub issue.
Note that the config makes it possible to create a blank issue, which should be handy for:
Because the blank issue option is easy to miss, it should probably be documented somewhere, but I'm not sure where. We can perhaps start with a note on CZO.
Relevant CZO threads:
Please review carefully, as my testing involved copy-pasting config files around to try things out.