From 2c9f9df3ace4f2146c4d6685ef9a074b36d8c186 Mon Sep 17 00:00:00 2001 From: Miguel Beltran Date: Tue, 26 Nov 2024 11:09:17 +0100 Subject: [PATCH] docs: add issue and PR templates --- .github/ISSUE_TEMPLATE/bug_report.md | 45 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 26 +++++++++++++ pull_request_template.md | 47 +++++++++++++++++++++++ 3 files changed, 118 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..e4ac84f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,45 @@ +--- +name: Bug report +about: Bug report +title: ": " +labels: needs triage +assignees: '' + +--- + +**Describe the bug** + +A clear and concise description of what the bug is. + +**To Reproduce** + +Steps to reproduce the behavior: + +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** + +A clear and concise description of what you expected to happen. + +Links to related tickets or other context are welcome here. + +**Screenshots** + +If applicable, add screenshots to help explain your problem. + +**Environment (please complete the following information):** + +- OS: [e.g. Linux/Windows/macOS etc] +- SDK version: [e.g. 1.2.3] +- Dotnet versions: [e.g. 8.0.7] + +**Logs** + +If applicable, include relevant logs or error messages here (please use code blocks to format properly). + +**Possible Solution** + +If you have suggestions for how the issue might be resolved or investigated, please describe them here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..0f9aa57 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,26 @@ +--- +name: Feature request +about: A new feature for this SDK +title: ": " +labels: needs triage +assignees: '' + +--- + +**Please describe your new feature request** + +A clear and concise description of what the problem is. Example: I'm always frustrated when [...] + +**Describe the solution you'd like** + +A clear and concise description of what you want to happen. + +Links to related tickets or other information are welcome here. + +**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. diff --git a/pull_request_template.md b/pull_request_template.md new file mode 100644 index 0000000..f56a033 --- /dev/null +++ b/pull_request_template.md @@ -0,0 +1,47 @@ +## [{ticket number/type}:] {title} + +### Description :memo: + +- **Purpose**: What issue does this PR address or what feature does it implement? +- **Approach**: How does this PR tackle the problem? + +**Type of change** + +*Delete options that are not relevant.* + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] This change requires a documentation update + +**Updates** + +:point_right: +:point_right: +:point_right: + +### Screenshots :camera: + +{Image here of before and after - if applicable} + +### Test plan :test_tube: + +*Provide guidance for how to QA your proposed changes. This is not only for a test but also useful for a reviewer.* + +{A test plan outlining scenarios to test} + +### Author to check :eyeglasses: + +- [ ] Project and all contained modules builds successfully +- [ ] Self-/dev-tested +- [ ] Unit/UI/Automation/Integration tests provided where applicable +- [ ] Code is written to standards +- [ ] Appropriate documentation written (code comments, internal docs) + +### Reviewer to check :heavy_check_mark: + +- [ ] Project and all contained modules builds successfully +- [ ] Change has been dev-/reviewer-tested, where possible +- [ ] Unit/UI/Automation/Integration tests provided where applicable +- [ ] Code is written to standards +- [ ] Appropriate documentation written (code comments, internal docs)