Skip to content

Commit

Permalink
docs(issue): πŸ“ Improve templates
Browse files Browse the repository at this point in the history
  • Loading branch information
krsiakdaniel committed Dec 14, 2024
1 parent d99ba1d commit e06c863
Show file tree
Hide file tree
Showing 4 changed files with 61 additions and 25 deletions.
47 changes: 33 additions & 14 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -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.
19 changes: 14 additions & 5 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ about: Template for new features.
title: 'feature: ✨ '
labels: Feature
assignees: krsiakdaniel

---

## Description
Expand All @@ -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.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/quick-task.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ about: Template for quick small task.
title: ''
labels: ''
assignees: krsiakdaniel

---

## Description
Expand All @@ -15,3 +14,4 @@ assignees: krsiakdaniel

- [ ] ...
- [ ] ...
- [ ] ...
18 changes: 13 additions & 5 deletions .github/ISSUE_TEMPLATE/refactoring.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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

- [ ] ...
Expand All @@ -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.

0 comments on commit e06c863

Please sign in to comment.