Skip to content

Commit

Permalink
chore: issue172 - Revamp issue and PR templates (#176)
Browse files Browse the repository at this point in the history
  • Loading branch information
isuPatches authored Dec 27, 2022
1 parent 520443e commit c895237
Show file tree
Hide file tree
Showing 6 changed files with 203 additions and 63 deletions.
41 changes: 0 additions & 41 deletions .github/ISSUE_TEMPLATE/bug-report.md

This file was deleted.

127 changes: 127 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
name: Bug Report
description: Create a report to help us improve
title: "[Bug]: "
labels: ["Bug", "From User", "Needs Investigation", "Status - In Triage"]
assignees:
- isuPatches
body:
- type: markdown
attributes:
value: |
Thank you for creating an issue to improve this library! Please check [the current issues](https://github.com/isuPatches/android-wisefy/issues) to make sure that the improvement isn't already being worked on.
It will be _EXTREMELY_ helpful if you also take a look at the [sample app](/app) to see how it behaves and if you can reproduce there as well.
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: ex. [email protected]
validations:
required: false
- type: textarea
id: repro
attributes:
label: Reproduction steps
description: "Please provide steps to reproduce the bug."
value: |
1.
2.
3.
...
render: bash
validations:
required: true
- type: input
id: expected-result
attributes:
label: Expected Result
description: Please describe the result expected by following the above reproduction steps
validations:
required: true
- type: input
id: actual-result
attributes:
label: Actual Result
description: Please describe what actually happened while following the above reproduction steps
validations:
required: true
- type: checkboxes
id: reproducible-with-sample-app
attributes:
label: Reproducible In Sample
description: Is the bug reproducible within the sample app provided in the repo?
options:
- label: "Yes"
required: true
- type: dropdown
id: version
attributes:
label: Version
description: What version of Wisefy were you using?
options:
- 5.0.0-RC2 (Edge)
- 5.0.0-RC1
- 4.0.0 (Default)
- 3.0.1
- 3.0.0
- 2.1.0-BETA1
- 2.0.1
- 2.0.0
- 2.0.0-BETA1
- 1.0.10
- 1.0.9
- 1.0.8
- 1.0.7
- 1.0.6
- 1.0.5
- 1.0.4
- 1.0.3
- 1.0.2
- 1.0.1
- 1.0.0
validations:
required: true
- type: dropdown
id: browsers
attributes:
label: What Android OS are you seeing the problem on?
multiple: true
options:
- Android 6-6.0.1 / Marshmallow / SDK 23
- Android 7 / Nougat / SDK 24
- Android 7.1-7.1.2 / Nougat / SDK 25
- Android 8 / Oreo / SDK 26
- Android 8.1 / Oreo / SDK 27
- Android 9 / Pie / SDK 28
- Android 10 / Tart / SDK 29
- Android 11 / Red Velvet Cake / SDK 30
- Android 12 / Snow Cone / SDK 31
- Android 12L / Snow Cone V2 / SDK 32
- Android 13 / Tiramisu / SDK 33
- type: input
id: phone-details
attributes:
label: Phone Details
description: What make and manufacturer is the device the problem was seen on?
placeholder: ex. Samsung Galaxy S22, Google Pixel 4a, etc.
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output from Wisefy. The copied logs will be automatically formatted into code, so no need for backticks.
render: shell
- type: checkboxes
id: phone-rooted
attributes:
label: Rooted Phone
description: Is the device rooted?
options:
- label: "Yes"
required: true
- type: markdown
attributes:
value: |
Screenshots are also welcome. Please attach them to the bug report.
22 changes: 0 additions & 22 deletions .github/ISSUE_TEMPLATE/feature-request.md

This file was deleted.

49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Feature Request
description: Suggest an idea for this project
title: "[Feature Request]: "
labels: ["TODO", "Enhancement", "From User"]
assignees:
- isuPatches
body:
- type: markdown
attributes:
value: |
Thank you for creating an issue to improve this library! Please check [the current issues](https://github.com/isuPatches/android-wisefy/issues) to make sure that the improvement isn't already being worked on.
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: ex. [email protected]
validations:
required: false
- type: input
id: description
attributes:
label: Description
description: Please describe the feature request with a high level overview. These could be user stories as well like 'As a developer I want ___ so that ___'
validations:
required:
true
- type: textarea
id: acceptance-criteria
attributes:
label: Acceptance Criteria
description: "Describe in more detail the request. (f.e. - a method is added to the library, - the method when called does ___, etc.)"
value: |
-
-
-
...
render: bash
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Please add any additional insight or use-cases for context.
- type: markdown
attributes:
value: |
Images are also welcome. Please attach them to the explanation for the feature request.
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Question
description: Ask a question about the library
title: "[Question]: "
labels: ["Question", "From User"]
assignees:
- isuPatches
body:
- type: markdown
attributes:
value: |
Thank you for being curious about this library! Please check [the closed issues](https://github.com/isuPatches/android-wisefy/issues) and the [FAQ](/documentation/FAQ.md) to make sure that your question hasn't already been answered.
Based on the outcome of this, documentation and the FAQ may be updated for future developers so that their life is made easier.
- type: textarea
id: question
attributes:
label: What's on your mind?
description: Please ask away
9 changes: 9 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
## Description

## Issue Link(s)

## How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Please also list any relevant details for your test configuration.

## Screenshots (if appropriate)

0 comments on commit c895237

Please sign in to comment.