From 582965c192c438786eeb513dabded005eecc8c80 Mon Sep 17 00:00:00 2001 From: mikeplotean Date: Mon, 16 Sep 2024 18:14:42 +0300 Subject: [PATCH] chore: update pr and issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 35 ++++++++++++----------- .github/ISSUE_TEMPLATE/feature_request.md | 4 +++ .github/pull_request_template.md | 29 ++++++++----------- 3 files changed, 34 insertions(+), 34 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index fe9365f4d..88b42eb06 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,36 +7,37 @@ assignees: '' --- -**Describe the bug** +## Describe the bug A clear and concise description of what the bug is. -**To Reproduce** +## To Reproduce + Steps to reproduce the behavior: + 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error -**Expected behavior** +## Expected behavior + A clear and concise description of what you expected to happen. -**Actual behavior** +## Actual behavior + A clear and concise description of what actually happens. -**Screenshots** -If applicable, add screenshots to help explain your problem. +## Environment + +- os version: [e.g. linux, windows, macos] +- docker version: [e.g. 27.0.1] +- compose version: [e.g. 2.28.1] +- java version [e.g. 18] -**Environment** -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] +## Screenshots + +If applicable, add screenshots to help explain your problem. -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] +## Additional context -**Additional context** Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 11fc491ef..bf1164f60 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -8,13 +8,17 @@ 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. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index fee6ff2bd..1b89afe5a 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,26 +1,21 @@ ## Description -Provide a clear and concise description of the changes made in this pull request. +Provide a clear and concise description of the changes made in this pull request: + -Fixes #[issue number] ## Type of Change -- [ ] 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 +- [ ] bug fix - change which fixes an issue +- [ ] new feature - change which adds functionality + ## Checklist -- [ ] I have performed a self-review of my code -- [ ] If it is a core feature, I have added thorough tests -- [ ] Do we need to implement analytics? -- [ ] Will this be part of a product update? If yes, please write one phrase about this update. -- [ ] My code follows the style guidelines of this project -- [ ] I have commented my code, particularly in hard-to-understand areas -- [ ] I have made corresponding changes to the documentation -- [ ] My changes generate no new warnings -- [ ] I have added tests that prove my fix is effective or that my feature works -- [ ] New and existing unit tests pass locally with my changes -- [ ] Any dependent changes have been merged and published in downstream modules +- [ ] code cleanup and self-review +- [ ] unit + e2e test coverage +- [ ] documentation updated accordingly + +## Breaking + +- \- \ No newline at end of file