From 2feb2a11a8aa072020aa45e35f501beece55480f Mon Sep 17 00:00:00 2001 From: diehlaws Date: Tue, 17 Mar 2020 14:01:11 -0700 Subject: [PATCH] Updating issue templates --- .github/ISSUE_TEMPLATE/bug-report.md | 42 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/documentation.md | 23 +++++++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 20 +++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 21 ------------ .github/ISSUE_TEMPLATE/general_issue.md | 32 ----------------- .github/ISSUE_TEMPLATE/questions-help.md | 29 ++++++++++++++++ 6 files changed, 114 insertions(+), 53 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/documentation.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/ISSUE_TEMPLATE/general_issue.md create mode 100644 .github/ISSUE_TEMPLATE/questions-help.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 0000000..9dceb49 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,42 @@ +--- +name: "\U0001F41B Bug report" +about: Create a report to help us improve +title: '' +labels: needs-triage, bug report +assignees: '' + +--- + +Confirm by changing [ ] to [x] below to ensure that it's a bug: +- [ ] I've gone though [Developer Guide](https://docs.aws.amazon.com/sdk-for-php/v3/developer-guide/welcome.html) and [API reference](https://docs.aws.amazon.com/aws-sdk-php/v3/api/index.html) +- [ ] I've checked [AWS Forums](https://forums.aws.amazon.com) and [StackOverflow](https://stackoverflow.com/questions/tagged/aws-php-sdk) for answers +- [ ] I've searched for [previous similar issues](https://github.com/aws/aws-sdk-php-laravel/issues) and didn't find any solution + +**Describe the bug** +A clear and concise description of what the bug is. + +**Version of AWS SDK for PHP?** +Example: v3.133.6 +* get SDK version by printing the output of `Aws\Sdk::VERSION` in your code +* if the SDK was installed via composer you can see the version installed with `composer show -i` + +**Version of AWS Service Provider for Laravel?** + + +**Version of Laravel (`php artisan --version`)?** + + +**Version of PHP (`php -v`)?** + + +**To Reproduce (observed behavior)** +Steps to reproduce the behavior (please share code or minimal repo) + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Additional context** +Any additional information relevant to the issue. Examples include any framework you may be using (e.g. Laravel, Wordpress) in conjunction with the AWS SDK for PHP, or PHP/environment config settings if the issue is related to memory or performance. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 0000000..9dd63f2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,23 @@ +--- +name: "\U0001F4DDDocumentation" +about: Suggest incorrect/improvement in documentation +title: '' +labels: needs-triage, documentation +assignees: '' + +--- + +**Describe the issue with documentation** +A clear and concise description of what the issue is. + +**To Reproduce (observed behavior)** +Steps to reproduce the behavior (please share code or minimal repo) + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Additional context** +Add any other context about the problem here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 0000000..c48cd8f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,20 @@ +--- +name: "\U0001F680 Feature request" +about: Suggest an idea for this project +title: '' +labels: needs-triage, feature-request +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 214d7e2..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: feature-request -assignees: '' - ---- - -### Is this related to a problem? -A clear and concise description of the issue, e.g. I'm always frustrated when... - -### Feature description -Describe what you want to happen. - -### Describe alternatives you've considered -Any alternative solutions or features you've considered. - -### Additional context -Add any other context or screenshots about the feature request here. - diff --git a/.github/ISSUE_TEMPLATE/general_issue.md b/.github/ISSUE_TEMPLATE/general_issue.md deleted file mode 100644 index 92ee2a6..0000000 --- a/.github/ISSUE_TEMPLATE/general_issue.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -name: General issue -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -Please fill out the sections below to help us address your issue. - -### Version of AWS SDK for PHP? - - -### Version of AWS Service Provider for Laravel? - - -### Version of Laravel (`php artisan --version`)? - - -### Version of PHP (`php -v`)? - - -### What issue did you see? - - -### Steps to reproduce -If you have a runnable example, please include it as a snippet or link to a repository/gist for larger code examples. - -### Additional context -Any additional information relevant to the issue, for example PHP/environment config settings if the issue is related to memory or performance. - diff --git a/.github/ISSUE_TEMPLATE/questions-help.md b/.github/ISSUE_TEMPLATE/questions-help.md new file mode 100644 index 0000000..530d8aa --- /dev/null +++ b/.github/ISSUE_TEMPLATE/questions-help.md @@ -0,0 +1,29 @@ +--- +name: "\U0001F4AC Questions / Help" +about: If you have questions, please check AWS Forums or StackOverflow +title: '' +labels: needs-triage, guidance +assignees: '' + +--- + +Confirm by changing [ ] to [x] below: +- [ ] I've gone though [Developer Guide](https://docs.aws.amazon.com/sdk-for-php/v3/developer-guide/welcome.html) and [API reference](https://docs.aws.amazon.com/aws-sdk-php/v3/api/index.html) +- [ ] I've checked [AWS Forums](https://forums.aws.amazon.com) and [StackOverflow](https://stackoverflow.com/questions/tagged/aws-php-sdk) for answers + +**Version of AWS SDK for PHP?** +Example: v3.133.6 +* get SDK version by printing the output of `Aws\Sdk::VERSION` in your code +* if the SDK was installed via composer you can see the version installed with `composer show -i` + +**Version of AWS Service Provider for Laravel?** + + +**Version of Laravel (`php artisan --version`)?** + + +**Version of PHP (`php -v`)?** + + +**Describe the question** +