Skip to content

Commit

Permalink
Added issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
wakaleo committed Aug 31, 2023
1 parent 35a970a commit 9d8df41
Show file tree
Hide file tree
Showing 3 changed files with 142 additions and 0 deletions.
91 changes: 91 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
name: Bug Report
description: Spotted a bug? Let's fix it!
title: "Feature X fails when Y happens"
body:
- type: markdown
attributes:
value: |
👋 Hello! Thanks for helping us make Serenity BDD better for everyone!
If you saw a bug, please provide as much information as possible to help us find it and fix it.
- type: textarea
id: bug-description
attributes:
label: What happened?
description: |
What error or unexpected behaviour did you observe?
Did you see any error messages?
Are there any execution logs you can share?
validations:
required: false

- type: textarea
id: expected-behaviour
attributes:
label: What did you expect to happen?
validations:
required: false

- type: textarea
id: serenity-bdd-versions
attributes:
label: Serenity BDD version
description: |
What **Serenity BDD modules** and **what versions** are you using? Are you on the [latest version](https://github.com/serenity-bdd/serenity-core#what-is-the-latest-stable-version-i-should-use)?
validations:
required: true

- type: input
id: java-version
attributes:
label: JDK version
description: |
What version of Java are you using?
To find out, run `java -version`
validations:
required: true

- type: textarea
id: execution-environment
attributes:
label: Execution environment
description: |
What **operating system** are you using?
What **web browser** are you using?
Are there any runtime dependencies that might be causing the issue?
validations:
required: false

- type: textarea
id: reproducible-example
attributes:
label: How to reproduce the bug.
description: |
The easier you make it for us to reproduce the issue, the more likely we will fix it.
Please provide a [minimal reproducible example](https://en.wikipedia.org/wiki/Minimal_reproducible_example) using one of the [Serenity BDD project templates](https://github.com/serenity-bdd?q=template&type=all&language=&sort=).
placeholder: |
Link to your GitHub repository demonstrating the issue: ...
Steps to reproduce:
- ...
validations:
required: true

- type: checkboxes
attributes:
label: How can we make it happen?
description: |
Serenity BDD is an open-source project, and we greatly appreciate your contribution to help make it better.
Please be aware that while we may be able to address this issue quickly, especially if it aligns with other work
we are currently doing, there is no SLA or guarantee that it will ever be fixed. If the issue is valuable for you
and your project and you want to improve the chances of getting it fixed, you have several options.
You can dive into the code yourself (with our guidance), hire a third party to fix it, or hire the Serenity BDD
team to do it for you. We're here to help in any way we can!
I would like to:
options:
- label: "work on this myself (with Serenity BDD team guidance)"
- label: "[hire the Serenity BDD team](https://www.serenity-dojo.com/serenity-bdd-enterprise-support) to build it for me"
- label: "add it to the Serenity BDD backlog and wait for a volunteer"
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Serenity BDD Community Chat
url: https://matrix.to/#/#serenity-bdd_serenity-core:gitter.im
about: "Ask and answer questions about Serenity BDD and become part of our Community!"
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Feature Request
description: Suggest an idea for Serenity BDD
title: "Serenity BDD should ..."
body:

- type: markdown
attributes:
value: |
👋 Hello! Thanks for proposing an enhancement to Serenity BDD! Tell us more about your idea.
- type: textarea
id: problem
attributes:
label: What's the problem you're trying to solve?
validations:
required: true

- type: textarea
id: solution
attributes:
label: How would you like to solve it?
description: |
What's your preferred solution, and why is it the best way to do it?
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Are there any alternatives?
description: |
Have you considered any alternative solutions or workarounds?
validations:
required: false

- type: checkboxes
attributes:
label: How can we make it happen?
description: |
We'll need someone to help make your idea happen.
I would like to:
options:
- label: "work on this myself (with Serenity BDD team guidance)"
- label: "[hire the Serenity BDD team](https://www.serenity-dojo.com/serenity-bdd-enterprise-support) to build it for me"
- label: "add it to the Serenity BDD backlog and wait for a volunteer"

0 comments on commit 9d8df41

Please sign in to comment.