Skip to content

Commit

Permalink
add feature request template
Browse files Browse the repository at this point in the history
  • Loading branch information
vitalets committed Jan 26, 2025
1 parent bfd469c commit 977737e
Show file tree
Hide file tree
Showing 4 changed files with 63 additions and 77 deletions.
26 changes: 16 additions & 10 deletions .github/ISSUE_TEMPLATE/1-bug-report.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: Bug Report 🪲
description: Create a bug report to help us improve
description: Report a bug to help us quickly identify and resolve issues.
title: '[Bug]: '
labels: bug
body:
Expand All @@ -15,7 +15,7 @@ body:
attributes:
label: Given
description: |
Describe your setup. For example:
Provide details about your setup, feature files, step definitions, and configuration. For example:
````
I have the following setup:
Expand Down Expand Up @@ -43,7 +43,7 @@ body:
attributes:
label: When
description: |
Describe your actions. For example:
Describe the steps you performed to produce the issue. For example:
````
I run the following command:
```shell
Expand All @@ -54,10 +54,12 @@ body:

- type: textarea
id: then
validations:
required: true
attributes:
label: Then
description: |
Describe the **actual** result. For example:
Provide the **actual** outcome. For example:
````
I see an error:
```
Expand All @@ -71,22 +73,25 @@ body:
validations:
required: true
attributes:
label: But I expect
label: Expected Result
description: |
Describe the **expected** result. For example:
````
I expect no errors and all tests to pass.
````
placeholder: What did you expect?
placeholder: What did you expect to happen?

- type: input
id: reproduction-url
validations:
required: false
attributes:
label: Reproduction demo URL
label: Reproduction Demo URL
description: |
You are **highly encouraged** to try reproducing your bug on the [playwright-bdd-example](https://github.com/vitalets/playwright-bdd-example).
It significantly reduces the time it takes to resolve your issue.
placeholder: https://github.com/%your-name%/playwright-bdd-example
You are **highly encouraged** to fork [playwright-bdd-example](https://github.com/vitalets/playwright-bdd-example) and modify it to reproduce the issue.
Then push the changes and share the link below.
It greatly speeds up issue resolution!
placeholder: https://github.com/johndoe/playwright-bdd-example

- type: textarea
id: envinfo
Expand All @@ -105,4 +110,5 @@ body:
@playwright/test: v1.49.1
@cucumber/cucumber: none
Playwright config file: playwright.config.ts
render: shell
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Feature Request 🚀
description: Request a new feature or improvement
title: '[Feature]: '
labels: enhancement
body:
- type: markdown
attributes:
value: |
Thank you for suggesting a new feature! Please fill out the following details to help us understand your request.
**Note:** Providing as much detail as possible helps us prioritize and design the feature effectively.
- type: textarea
id: problem
attributes:
label: Describe the Problem
description: Explain the current issue or limitation you’re facing. What challenge does this create?
placeholder: Clearly describe the problem or limitation.
validations:
required: true

- type: textarea
id: solution
attributes:
label: Proposed Solution
description: Describe your idea for addressing the problem. How do you envision this feature working?
placeholder: Detail the solution or feature you'd like to see.
validations:
required: true

- type: textarea
id: context
attributes:
label: Additional Context
description: Share any supporting information, such as screenshots, examples, or use cases.
placeholder: Provide any additional context or background information.

- type: dropdown
id: priority
attributes:
label: Priority Level
description: How urgent or important is this feature for you?
options:
- Low
- Medium
- High
- Critical
default: Medium
43 changes: 0 additions & 43 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

24 changes: 0 additions & 24 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

0 comments on commit 977737e

Please sign in to comment.