From e06c8635fbde66a11f65466bb83f4567599c1fb3 Mon Sep 17 00:00:00 2001 From: Krsiak Daniel Date: Sat, 14 Dec 2024 23:35:16 +0100 Subject: [PATCH] =?UTF-8?q?docs(issue):=20=F0=9F=93=9D=20Improve=20templat?= =?UTF-8?q?es?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/ISSUE_TEMPLATE/bug-report.md | 47 ++++++++++++++++------- .github/ISSUE_TEMPLATE/feature-request.md | 19 ++++++--- .github/ISSUE_TEMPLATE/quick-task.md | 2 +- .github/ISSUE_TEMPLATE/refactoring.md | 18 ++++++--- 4 files changed, 61 insertions(+), 25 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 9e48703f..8b07e8d0 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -1,40 +1,59 @@ --- name: Bug report about: Create a report for bug fix. -title: '' +title: 'fix: 🐛 ' labels: Fix assignees: krsiakdaniel - --- -## Describe the bug +## Description -A clear and concise description of what the bug is. +Describe what the bug is. ## Steps to reproduce bug 1. Go to '...' 2. Click on '...' 3. Scroll down to '...' -4. See error. +4. See the bug. ## Expected behavior -A clear and concise description of what you expected to happen. +Describe what you expect to happen. + +## Code Example + +Provide a code example if applicable. + +```ts +code_example +``` + +## Tasks + +- [ ] ... +- [ ] ... +- [ ] ... ## Desktop -- OS: -- Browser: -- Version: +- OS: `name` +- Browser: `name` +- Version: `number` ## Smartphone -- Device: -- OS: -- Browser: -- Version: +- Device: `name` +- OS: `name` +- Browser: `name` +- Version: `number` + +## Acceptance Criteria + +- [ ] Functionality is fixed. +- [ ] All tests pass successfully. +- [ ] Code is reviewed and approved through PR. ## Screenshots -Attach relevant screenshots or design mockups if applicable. +Attach relevant screenshots if applicable. diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index d3494f07..84978901 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -4,7 +4,6 @@ about: Template for new features. title: 'feature: ✨ ' labels: Feature assignees: krsiakdaniel - --- ## Description @@ -13,22 +12,32 @@ Describe the purpose of the feature. ## Benefits -Explain the benefits or impact this feature will have on the project. +Explain the benefits this feature will have on the project. ## Implementation Include steps, tools, or components to be modified. +## Code Example + +Provide a code example if applicable. + +```ts +code_example +``` + ## Tasks +- [ ] ... - [ ] ... - [ ] ... ## Acceptance Criteria -- ... -- ... +- [ ] New functionality is implemented. +- [ ] All tests pass successfully. +- [ ] Code is reviewed and approved through PR. ## Screenshots -Attach relevant screenshots or design mockups if applicable. +Attach relevant screenshots if applicable. diff --git a/.github/ISSUE_TEMPLATE/quick-task.md b/.github/ISSUE_TEMPLATE/quick-task.md index a3b3277d..e9cd9e64 100644 --- a/.github/ISSUE_TEMPLATE/quick-task.md +++ b/.github/ISSUE_TEMPLATE/quick-task.md @@ -4,7 +4,6 @@ about: Template for quick small task. title: '' labels: '' assignees: krsiakdaniel - --- ## Description @@ -15,3 +14,4 @@ assignees: krsiakdaniel - [ ] ... - [ ] ... +- [ ] ... diff --git a/.github/ISSUE_TEMPLATE/refactoring.md b/.github/ISSUE_TEMPLATE/refactoring.md index 0eda14a8..71e06d0f 100644 --- a/.github/ISSUE_TEMPLATE/refactoring.md +++ b/.github/ISSUE_TEMPLATE/refactoring.md @@ -1,14 +1,14 @@ --- name: Refactoring about: Template for refactoring. -title: '' +title: 'refactor: 👷 ' labels: Refactor assignees: krsiakdaniel --- ## Description -Describe the purpose and scope of the refactoring. +Describe the purpose of the refactoring. ## Benefits @@ -22,6 +22,14 @@ Describe the purpose and scope of the refactoring. - Modularize or break down complex functions. - Update images. +## Code Example + +Provide a code example if applicable. + +```ts +code_example +``` + ## Tasks - [ ] ... @@ -30,10 +38,10 @@ Describe the purpose and scope of the refactoring. ## Acceptance Criteria -- [ ] Functionality remains unchanged and passes all tests. -- [ ] All tests (unit, integration, E2E) pass successfully. +- [ ] Functionality remains unchanged. +- [ ] All tests pass successfully. - [ ] Code is reviewed and approved through PR. ## Screenshots -Attach relevant screenshots or design mockups if applicable. +Attach relevant screenshots if applicable.