Add default templates for issues and PRs #7
Conversation
ISSUE_TEMPLATE/01_bug_report.md
Outdated
| <!-- | ||
| 3. Describe your environment, including | ||
| - Version | ||
| - Deployment environment (e.g. VMware appliance, EC2 appliance, Containers, etc) |
There was a problem hiding this comment.
This part was interesting. Since this is at the org level, this template will apply to everything (the ManageIQ appliancation, gems, build repos, docs, etc). I wasn't sure how to present this for all of those, so I'm up for some help here. The goal is short and sweet, so I don't want to put too much to be annoying.
There was a problem hiding this comment.
Is there a magic variable for current repo that we could put context specific information? For gems like kubeclient, optimist, linux_admin, etc. this template could be confusing.
There was a problem hiding this comment.
No it's just a straight text file. It we want to override we have to create a file in the repo itself
There was a problem hiding this comment.
Maybe a few of us can jump on a call, merge this, and see how it looks for several repos and add any overrides for repos where this template would be confusing, such as: kubeclient, optimist, linux_admin.
| contact_links: | ||
| - name: ":question: Question / Support" | ||
| url: https://github.com/orgs/ManageIQ/discussions | ||
| about: Please ask and answer questions here. |
There was a problem hiding this comment.
The goal here was to push people asking questions to the discussions instead of opening actionable tickets. It should show up at the bottom of the chooser list, but it's hard for me to know until we merge it.
PULL_REQUEST_TEMPLATE.md
Outdated
| --> | ||
|
|
||
| <!-- | ||
| 3. Tell @miq-bot to label this PR with an appropriate scope label (bug, enhancement, etc) |
There was a problem hiding this comment.
Any reason for this item to be different from the issue templates?
There was a problem hiding this comment.
In the issue template we know ahead of time if it's a bug or enhancement, since those are the 2 choices we offer. For PRs we don't know what it's for.
ISSUE_TEMPLATE/01_bug_report.md
Outdated
| 3. Describe your environment, including | ||
| - Version | ||
| - Deployment environment (e.g. VMware appliance, EC2 appliance, Containers, etc) |
There was a problem hiding this comment.
| 3. Describe your environment, including | |
| - Version | |
| - Deployment environment (e.g. VMware appliance, EC2 appliance, Containers, etc) | |
| 3. Describe your environment, including | |
| - Version | |
| - Environment | |
| - For ManageIQ: VMware appliance, EC2 appliance, Monolithic container, Kubernetes operator, etc | |
| - For gems: `gem env`, `bundle env`, `ruby -v`, etc |
ISSUE_TEMPLATE/01_bug_report.md
Outdated
| --> | ||
|
|
||
| <!-- | ||
| 2. Describe the steps to reproduce, including any log snippets that will help diagnose. |
There was a problem hiding this comment.
| 2. Describe the steps to reproduce, including any log snippets that will help diagnose. | |
| 2. Describe the steps to reproduce, including any log snippets and stack traces that will help diagnose. |
Fryguy
force-pushed
the
add_default_templates
branch
from
4b11b33 to
cc166d3
Compare
Drop PR template after merge of ManageIQ/.github#7
Drop Issue/PR templates after merge of ManageIQ/.github#7
Drop PR template after merge of ManageIQ/.github#7
Drop Issue/PR templates after merge of ManageIQ/.github#7
3 participants
@ManageIQ/core-admins Please review.
My goal is to eventually also remove the bespoke Issue and PR templates, and ideally only have this consistent list, except where we need to override it.
I tried really hard to keep it short and sweet. As a contributor, I really can't stand walls-of-words, especially they make me break it down into separate "describe the problem/what happened/what did you expect to happen" sections.
As a reviewer I can't stand seeing all the boilerplate, cause it just gets in the way, especially when the author doesn't remove the boilerplate help text. So I listed them here as actual HTML comments, so if contributors do leave them in, then at least the final result we look at doesn't have all that stuff.
TODO: Remove Issue/PR templates from other repos