From f61f37400070d4537d03cf6d2b3da75dd4581cd2 Mon Sep 17 00:00:00 2001 From: Mark Sagi-Kazar Date: Mon, 19 Nov 2018 15:03:43 +0100 Subject: [PATCH] Improve github issue templates --- .github/ISSUE_TEMPLATE.md | 28 +--------------------- .github/ISSUE_TEMPLATE/bug_report.md | 18 ++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 14 +++++++++++ .github/ISSUE_TEMPLATE/security_issue.md | 10 ++++++++ .github/ISSUE_TEMPLATE/support_question.md | 10 ++++++++ .github/SUPPORT.md | 18 ++++++++++++++ 6 files changed, 71 insertions(+), 27 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/security_issue.md create mode 100644 .github/ISSUE_TEMPLATE/support_question.md create mode 100644 .github/SUPPORT.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index d4ecf20f..f822c0dd 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,27 +1 @@ -| Q | A -| ------------ | --- -| Bug? | no|yes -| New Feature? | no|yes -| Version | Specific version or SHA of a commit - - -#### Actual Behavior - -What is the actual behavior? - - -#### Expected Behavior - -What is the behavior you expect? - - -#### Steps to Reproduce - -What are the steps to reproduce this bug? Please add code examples, -screenshots or links to GitHub repositories that reproduce the problem. - - -#### Possible Solutions - -If you have already ideas how to solve the issue, add them here. -(remove this section if not needed) +Please consider using one of the issue templates (bug report, feature request). diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..37bc0296 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,18 @@ +--- +name: 🐛 Bug Report +about: Report errors and problems +--- + +**Guzzle version(s) affected**: x.y.z + +**Description** + + +**How to reproduce** + + +**Possible Solution** + + +**Additional context** + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..981f4f67 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,14 @@ +--- +name: 🚀 Feature Request +about: RFC and ideas for new features and improvements +--- + +**Description** + + +**Example** + + +**Additional context** + diff --git a/.github/ISSUE_TEMPLATE/security_issue.md b/.github/ISSUE_TEMPLATE/security_issue.md new file mode 100644 index 00000000..84ae4e55 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/security_issue.md @@ -0,0 +1,10 @@ +--- +name: ⛔ Security Issue +about: See the description to report security-related issues +--- + +⚠ PLEASE DON'T DISCLOSE SECURITY-RELATED ISSUES PUBLICLY, SEE BELOW. + +If you have found a security issue in Guzzle, please send the details to +security [at] guzzlephp.org and don't disclose it publicly until we can provide a +fix for it. diff --git a/.github/ISSUE_TEMPLATE/support_question.md b/.github/ISSUE_TEMPLATE/support_question.md new file mode 100644 index 00000000..383c6f40 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/support_question.md @@ -0,0 +1,10 @@ +--- +name: ⛔ Support Question +about: See https://github.com/guzzle/guzzle/blob/master/.github/SUPPORT.md for questions about using Guzzle and its components +--- + +We use GitHub issues only to discuss about Guzzle bugs and new features. +For this kind of questions about using Guzzle, +please use any of the support alternatives shown in https://github.com/guzzle/guzzle/blob/master/.github/SUPPORT.md + +Thanks! diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md new file mode 100644 index 00000000..0abc5933 --- /dev/null +++ b/.github/SUPPORT.md @@ -0,0 +1,18 @@ +# Support + +If you're looking for support for Guzzle, here are a few options: + +- [Documentation](http://guzzlephp.org/) +- [Gitter](https://gitter.im/guzzle/guzzle) +- [#guzzle](https://php-http.slack.com/messages/CE6UAAKL4/) channel in [PHP-HTTP](http://php-http.org) Slack team + +Guzzle is a relatively old project, so chances are you will find +much about them on Google or Stack Overflow: + +- [guzzle](https://stackoverflow.com/questions/tagged/guzzle) tag on Stack Overflow (recommended) +- [guzzlehttp](https://stackoverflow.com/questions/tagged/guzzlehttp) tag on Stack Overflow +- [guzzle6](https://stackoverflow.com/questions/tagged/guzzle6) tag on Stack Overflow + + +You can also browse the issue tracker for support requests, +but we encourage everyone to use the channels above instead.