From b741f88a6a45eed17bd1777a81e1d78efadd8337 Mon Sep 17 00:00:00 2001 From: mesilov Date: Tue, 3 Sep 2024 01:44:54 +0600 Subject: [PATCH] Add issue and PR templates Introduce templates for bug reports and feature requests for both SDK and REST-API. Disable blank issues and add a pull request template to standardize contributions. Signed-off-by: mesilov --- .github/ISSUE_TEMPLATE/1_bug_report_sdk.yaml | 41 +++++++++++++++++++ .../ISSUE_TEMPLATE/2_feature_request_sdk.yaml | 17 ++++++++ .../ISSUE_TEMPLATE/3_bug_report_rest_api.yaml | 41 +++++++++++++++++++ .../4_feature_request_rest_api.yaml | 17 ++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/PULL_REQUEST_TEMPLATE.md | 16 ++++++++ 6 files changed, 133 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/1_bug_report_sdk.yaml create mode 100644 .github/ISSUE_TEMPLATE/2_feature_request_sdk.yaml create mode 100644 .github/ISSUE_TEMPLATE/3_bug_report_rest_api.yaml create mode 100644 .github/ISSUE_TEMPLATE/4_feature_request_rest_api.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/1_bug_report_sdk.yaml b/.github/ISSUE_TEMPLATE/1_bug_report_sdk.yaml new file mode 100644 index 00000000..38c0be45 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1_bug_report_sdk.yaml @@ -0,0 +1,41 @@ +name: 🐛 SDK bug report +description: SDK bug report template +labels: bug in SDK + +body: + - type: input + id: affected-versions + attributes: + label: version(s) affected + placeholder: x.y.z + validations: + required: true + - type: textarea + id: description + attributes: + label: Description + description: A clear and concise description of the problem in SDK + validations: + required: true + - type: textarea + id: how-to-reproduce + attributes: + label: How to reproduce + description: | + ⚠️ This is the most important part of the report ⚠️ + Without a way to easily reproduce your issue, there is little chance we will be able to help you and work on a fix. + Please, take the time to show us some code and/or config that is needed for others to reproduce the problem easily. + validations: + required: true + - type: textarea + id: possible-solution + attributes: + label: Possible Solution + description: | + Optional: only if you have suggestions on a fix/reason for the bug + Don't hesitate to create a pull request with your solution, it helps get faster feedback. + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: "Optional: any other context about the problem: log messages, screenshots, etc." \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/2_feature_request_sdk.yaml b/.github/ISSUE_TEMPLATE/2_feature_request_sdk.yaml new file mode 100644 index 00000000..a00d657d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2_feature_request_sdk.yaml @@ -0,0 +1,17 @@ +name: 🚀 SDK Feature Request +description: Ideas for new features and improvements in SDK +body: + - type: textarea + id: description + attributes: + label: Description + description: A clear and concise description of the new feature + validations: + required: true + - type: textarea + id: example + attributes: + label: Example + description: | + A simple example of the new feature in action (include PHP code, YAML config, etc.) + If the new feature changes an existing feature, include a simple before/after comparison. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/3_bug_report_rest_api.yaml b/.github/ISSUE_TEMPLATE/3_bug_report_rest_api.yaml new file mode 100644 index 00000000..cec3a401 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3_bug_report_rest_api.yaml @@ -0,0 +1,41 @@ +name: 🐛 REST-API bug report +description: REST-API bug report template +labels: bug in REST-API + +body: + - type: input + id: api-method + attributes: + label: REST-API method name + placeholder: user.current + validations: + required: true + - type: textarea + id: description + attributes: + label: Description + description: A clear and concise description of the problem in REST-API call + validations: + required: true + - type: textarea + id: how-to-reproduce + attributes: + label: How to reproduce + description: | + ⚠️ This is the most important part of the report ⚠️ + Without a way to easily reproduce your issue, there is little chance we will be able to help you and work on a fix. + Please, take the time to show us some code and/or config that is needed for others to reproduce the problem easily. + validations: + required: true + - type: textarea + id: possible-solution + attributes: + label: Possible Solution + description: | + Optional: only if you have suggestions on a fix/reason for the bug + Don't hesitate to create a pull request with your solution, it helps get faster feedback. + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: "Optional: any other context about the problem: log messages, screenshots, etc." \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/4_feature_request_rest_api.yaml b/.github/ISSUE_TEMPLATE/4_feature_request_rest_api.yaml new file mode 100644 index 00000000..5e1036c8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/4_feature_request_rest_api.yaml @@ -0,0 +1,17 @@ +name: 🚀 REST-API Feature Request +description: Ideas for new features and improvements in REST-API +body: + - type: textarea + id: description + attributes: + label: Description + description: A clear and concise description of the new feature + validations: + required: true + - type: textarea + id: example + attributes: + label: Example + description: | + A simple example of the new feature in action (include PHP code, YAML config, etc.) + If the new feature changes an existing feature, include a simple before/after comparison. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..ec4bb386 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..2b707b03 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,16 @@ +| Q | A | +|---------------|---------------------------------------------------------------------------------------------------------------------------| +| Bug fix? | yes/no | +| New feature? | yes/no | +| Deprecations? | yes/no | +| Issues | Fix #... | +| License | **MIT** | + + \ No newline at end of file