Browse Source

DX: Improve issue templates (#7942)

Greg Korba 11 months ago
parent
commit
ce40b805e9

+ 65 - 0
.github/ISSUE_TEMPLATE/1-bug_report.yml

@@ -0,0 +1,65 @@
+name: Bug report 🐛
+description: Existing feature does not behave as expected.
+labels: [ "kind/bug", "status/to verify" ]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Before reporting a bug, make sure PHP-CS-Fixer is up-to-date and the problem is/was not reported already.
+  - type: textarea
+    id: problem-description
+    attributes:
+      label: Problem description
+      description: Please describe encountered problem and provide the background of it
+    validations:
+      required: true
+  - type: textarea
+    id: minimal-reproducer
+    attributes:
+      label: Minimal reproducer
+      description: |
+        Provide a minimal code snippet and the CLI command that should be run to reproduce the problem.
+        Please see how to utilise `--rules` option on the [usage page](https://cs.symfony.com/doc/usage.html).
+
+        If it's not possible to prepare short CLI reproducer command, please provide complete config used in your project.
+
+        If relevant, provide the expected output, the actual output and/or the error that occurred, if any.
+
+        Please use markdown syntax for each code snippet.
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: Fixer version
+      description: Provide PHP CS Fixer version in X.Y.Z format (run `php-cs-fixer -v` to get it)
+    validations:
+      required: true
+  - type: input
+    id: php-version
+    attributes:
+      label: PHP version
+      description: Which PHP version Fixer is run on?
+    validations:
+      required: true
+  - type: dropdown
+    id: run-method
+    attributes:
+      label: How do you run Fixer?
+      multiple: false
+      options:
+        - Composer package
+        - Composer Shim package (binary only)
+        - PHAR
+        - Docker
+    validations:
+      required: true
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Contribution Checks
+      options:
+        - label: I have verified if this problem was already reported
+          required: false
+        - label: I am familiar with ["Feature or bug?"](https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/blob/master/feature-or-bug.rst)
+          required: false

+ 37 - 0
.github/ISSUE_TEMPLATE/2-feature_request.yml

@@ -0,0 +1,37 @@
+name: Feature request 🚀
+description: I have a suggestion about a new feature (and may want to implement it)!
+labels: [ "kind/feature request", "status/to verify" ]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Before requesting a new feature, make sure your version of PHP-CS-Fixer is up-to-date.
+
+        > [!IMPORTANT]
+        > For initial ideas it's preferable to use [discussions](https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/discussions/categories/feature-ideas).
+
+        As a maintainers we prefer to have only actionable issues in the backlog, with clear definition of done,
+        that's why Discussions are the best way to start. When scope of the request is established, then actual issue can be created.
+  - type: textarea
+    id: feature-request
+    attributes:
+      label: Feature request
+      description: Please describe the feature you would like to see implemented.
+    validations:
+      required: true
+  - type: input
+    id: discussion-reference
+    attributes:
+      label: Link to Discussion where feature request was formed
+      placeholder: "https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/discussions/<ID>"
+    validations:
+      required: false
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Contribution Checks
+      options:
+        - label: I have verified if this feature request was already discussed
+          required: false
+        - label: I am familiar with ["Feature or bug?"](https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/blob/master/feature-or-bug.rst)
+          required: false

+ 0 - 54
.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,54 +0,0 @@
----
-name: Bug report 🐛
-about: Existing feature does not behave as expected.
-labels: kind/bug
----
-
-## Bug report
-
-<!--
-  Before reporting a bug, make sure PHP CS Fixer is up-to-date.
-
-  Check that the issue is NOT regarded to an applied rule by using the `-vvv` option (will list applied rules) on a minimal code snippet.
--->
-
-### Description
-
-<!--
-  Please describe the problem.
--->
-
-### Runtime version
-
-<!--
-  Provide PHP CS Fixer version and PHP runtime by sharing result of this command:
-  $ php-cs-fixer -V
--->
-
-### Used command
-
-<!--
-  Provide the command used to run PHP CS Fixer (run with `-vvv`).
--->
-
-### Configuration file
-
-<!--
-  Provide content of configuration file you used (.php-cs-fixer[.dist].php).
--->
-
-### Code snippet that reproduces the problem
-
-<!--
-  Provide a minimal code snippet before running PHP CS Fixer. If relevant,
-  also provide the expected output, the actual output and/or the error that
-  occurred, if any.
-
-  Please use markdown syntax for each code snippet, e.g.:
-
-  ```php
-  <?php
-  $var = 'foo';
-  ```
-
--->

+ 1 - 1
.github/ISSUE_TEMPLATE/config.yml

@@ -2,7 +2,7 @@ blank_issues_enabled: false
 contact_links:
   - name: RFC ↔️
     url: https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/discussions/categories/rfc
-    about: If you have an idea about Fixer development (new rules, supporting tools, processes), please open RFC
+    about: If you have an idea about Fixer development (core architecture, supporting tools, processes), please open RFC
   - name: Support question❓
     url: https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/discussions/categories/q-a
     about: If you have any questions about configuring, using or developing PHP-CS-Fixer, please open new Q&A discussion

+ 0 - 11
.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,11 +0,0 @@
----
-name: Feature request 🚀
-about: I have a suggestion about a new feature (and may want to implement it)!
-labels: kind/feature request
----
-
-## Feature request
-
-<!--
-  Please describe the feature you would like to see implemented.
--->