chore: adding organization wide issue template #7
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| name: Bug Report | ||
| description: File a bug report | ||
| title: "" | ||
| labels: ["triage"] | ||
| type: "bug" | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| ## Thanks for taking the time to fill out this bug report! | ||
| Before creating a bug report, be sure to keep the following points in mind: | ||
| - Search existing reports to make sure there isn't already an existing bug report. | ||
| - Make sure this is the correct project for your report. If the report is related to a plugin or Capacitor core, create the bug report on that GitHub project instead. | ||
| - Feel free to chat with us in [discussions](https://github.com/ionic-team/capacitor/discussions) if you are unsure whether something is a bug or feature request. | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Description | ||
| description: "Give a detailed explanation of the bug you've encountered." | ||
|
There was a problem hiding this comment. Should we go into more information into what we're looking for here? I don't if we can get into specifics on what we're looking for in the description, because it can vary a lot per issue. Just thinking if we can add any more info here that can help people that may be opening a bug report for the first time in our repos. |
||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: expected-behavior | ||
| attributes: | ||
| label: Expected Behavior | ||
| description: "Describe what you expected to happen, or what should be the correct behavior." | ||
| validations: | ||
| required: true | ||
|
There was a problem hiding this comment. What about current or obtained behavior? Would that be in description? In my head we'd have both those fields next to each other, to be able to succinctly understand what's the expectation vs reality. |
||
| - type: input | ||
| id: reproduction | ||
| attributes: | ||
| label: Reproduction | ||
| description: "Include a link to a minimal test project that demonstrates the bug." | ||
| validations: | ||
| required: false | ||
|
Comment on lines
+34
to
+35
There was a problem hiding this comment. Shouldn't we require |
||
| - type: textarea | ||
| id: media | ||
| attributes: | ||
| label: Screenshots / Media | ||
| description: "Include screenshots, video recordings or other collateral that helps illustrate the problem described in the bug." | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| id: env-details | ||
| attributes: | ||
| label: Environment Details | ||
| description: "Please provide the following information with your request and any other relevant technical details (versions of IDEs, local environment info, plugin information or links, etc)." | ||
| placeholder: | | ||
| OS version: | ||
| `npx cap doctor` output: | ||
| npm --version output: | ||
| node --version output: | ||
| pod --version output (iOS Cocoapods issues only): | ||
| render: Shell | ||
| validations: | ||
| required: false | ||
|
Comment on lines
+47
to
+56
There was a problem hiding this comment. Shouldn't |
||
| - type: checkboxes | ||
| id: versions-affected | ||
| attributes: | ||
| label: Versions Affected | ||
| description: "Check the versions that this bug is related to." | ||
| options: | ||
| - label: 7.x | ||
| required: false | ||
| - label: 8.x | ||
| required: false | ||
| - label: 9.x | ||
| required: false | ||
|
Comment on lines
+57
to
+68
There was a problem hiding this comment. These versions vary according to the repo no? How can it be re-used / configured? |
||
| - type: checkboxes | ||
| id: platforms-affected | ||
| attributes: | ||
| label: Platforms Affected | ||
| description: "Check the platforms that this bug is related to." | ||
| options: | ||
| - label: iOS | ||
| required: false | ||
| - label: Android | ||
| required: false | ||
| - label: Web | ||
| required: false | ||
|
There was a problem hiding this comment. Is this configurable by the consuming repos? I reckon for Capacitor we'd want to have this information required, but if we want to use it across all our |
||
| - type: textarea | ||
| id: notes | ||
| attributes: | ||
| label: Notes / Comments | ||
| description: "Anything else we need to know to help? Include it here." | ||
| validations: | ||
| required: false | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do you mean by "If the report is related to a plugin or Capacitor core, create the bug report on that GitHub project instead"?
Are you meaning to say, if you're having an issue with a plugin, open in the appropriate GitHub repo for the plugin, instead of Capacitor?