Browse Source

Introduce new issue templates

Julien Falque 4 years ago
parent
commit
64fb3d6de4

+ 0 - 34
.github/ISSUE_TEMPLATE

@@ -1,34 +0,0 @@
-For configuration or updating questions please read the README and UPGRADE documentation,
-or visit: https://gitter.im/PHP-CS-Fixer
-
-When reporting an issue (bug) please provide the following information:
-
-#### The PHP version you are using (`$ php -v`):
-=> ....................................
-
-#### PHP CS Fixer version you are using (`$ php-cs-fixer -V`):
-=> ....................................
-
-#### The command you use to run PHP CS Fixer:
-=> ....................................
-
-#### The configuration file you are using, if any:
-```php
-=> ....................................
-```
-
-#### If applicable, please provide minimum samples of PHP code (as plain text, not screenshots):
- * before running PHP CS Fixer (no changes):
-```php
-=> ....................................
-```
-
- * with unexpected changes applied when running PHP CS Fixer:
-```php
-=> ....................................
-```
-
- * with the changes you expected instead:
-```php
-=> ....................................
-```

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

@@ -0,0 +1,32 @@
+---
+name: Bug report ๐Ÿ›
+about: Existing feature does not behave as expected.
+label: kind/bug
+---
+
+## Bug report
+
+<!--
+  Before reporting a bug, make sure PHP CS Fixer is up-to-date.
+
+  Please describe the problem and provide technical details such as:
+   * PHP version: php -v
+   * PHP CS Fixer version: php-cs-fixer -V
+   * the command used to run PHP CS Fixer
+   * the configuration file you used
+-->
+
+### 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
+  occured, if any.
+
+  Please use markdown syntax for each code snippet, e.g.:
+
+  ```php
+  <?php
+  $var = 'foo';
+  ```
+-->

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

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

+ 25 - 0
.github/ISSUE_TEMPLATE/rule_request.md

@@ -0,0 +1,25 @@
+---
+name: Rule request โœ๏ธ
+about: I have a suggestion about a new rule (and may want to implement it)!
+label: kind/feature request
+---
+
+## Rule request
+
+<!--
+  Please describe the new rule or the new rule option you would like to see
+  implemented.
+-->
+
+### Code snippet that shows how the rule would fix PHP code
+
+<!--
+  Provide minimal code snippets that show what the new rule would do.
+
+  Please use markdown syntax for each code snippet, e.g.:
+
+  ```php
+  <?php
+  $var = 'foo';
+  ```
+-->

+ 15 - 0
.github/ISSUE_TEMPLATE/support_question.md

@@ -0,0 +1,15 @@
+---
+name: Support question โ“
+about: You have a question about how the tool works or how to use it.
+label: kind/question
+---
+
+## Support question
+
+<!--
+  Before creating a new support question, you may want to reach the community at
+  https://gitter.im/PHP-CS-Fixer/Lobby
+
+  Please describe in as much detail as possible what problem you are trying to
+  solve and what have you tried so far.
+-->