mirror of
https://github.com/commons-app/apps-android-commons.git
synced 2025-10-26 04:13:53 +01:00
GitHub issue forms (#4804)
* .github: move pull request template into .github directory This keeps it out of the root directory. The main intention is that keeping it out-of-root helps give it less attention which is enough for the template. * .github: add a issue form template for the app This is based on the exisitng issue template of the app. It has some additional tweaks done to update stale information. * .github: add some more issue templates
This commit is contained in:
Kaartic Sivaraam
GitHub
parent
aab0bc1b36
commit
e6c64b9368
6 changed files with 174 additions and 36 deletions
85
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
Normal file
85
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
Normal file
|
|
@ -0,0 +1,85 @@
|
|||
name: "\U0001F41E Bug report"
|
||||
description: Create a report to help us improve.
|
||||
title: "[Bug]: "
|
||||
labels: ["bug"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
- Before creating an issue, please search the existing issues to see if a similar one has already been created.
|
||||
- You can search issues by specific labels (e.g. `label:nearby`) or just by typing keywords into the search filter.
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Summary
|
||||
description: Summarize your issue (what goes wrong, what did you expect to happen)
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Steps to reproduce
|
||||
description: How can we reproduce the issue?
|
||||
placeholder: |
|
||||
1. Have the app open..
|
||||
2. Go to..
|
||||
3. Click on..
|
||||
4. Observe..
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Expected behaviour
|
||||
placeholder: A menu should open..
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Actual behaviour
|
||||
placeholder: The app closes unexpectedly..
|
||||
validations:
|
||||
required: true
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
# Device information
|
||||
- type: input
|
||||
attributes:
|
||||
label: Device name
|
||||
description: What make and model device did you encounter this on?
|
||||
placeholder: Samsung J7
|
||||
validations:
|
||||
required: false
|
||||
- type: input
|
||||
attributes:
|
||||
label: Android version
|
||||
description: What Android version (e.g., Android 6.0 Marshmallow or Android 11) are you running? Is it the stock version from the manufacturer or a custom ROM ?
|
||||
placeholder: Android 10
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
attributes:
|
||||
label: Commons app version
|
||||
description: You can find this information by clicking the right-most menu in the bottom navigation bar in the app and tapping 'About'. If you are building from our codebase instead of downloading the app, please also mention the branch and build variant (e.g. `master` and `prodDebug`).
|
||||
placeholder: 3.1.1
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Device logs
|
||||
description: Add logcat files here (if possible). Need help? See "[Getting app logs from Android Studio](https://commons-app.github.io/docs.html#getting-app-logs-from-android-studio)".
|
||||
validations:
|
||||
required: false
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Screen-shots
|
||||
description: Add screenshots related to the issue (if available). Can be created by pressing the Volume Down and Power Button at the same time on Android 4.0 and higher.
|
||||
validations:
|
||||
required: false
|
||||
- type: dropdown
|
||||
attributes:
|
||||
label: Would you like to work on the issue?
|
||||
description: Please let us know whether you want to fix the issue by yourself. If not, anyone can get the issue assigned to them.
|
||||
options:
|
||||
- "Yes"
|
||||
- Prefer not
|
||||
validations:
|
||||
required: false
|
||||
30
.github/ISSUE_TEMPLATE/feature-request.yml
vendored
Normal file
30
.github/ISSUE_TEMPLATE/feature-request.yml
vendored
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
name: "⭐️ Feature request"
|
||||
description: Suggest an idea for this project
|
||||
labels: ["enhancement"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
- Please do your best to search for duplicate issues before filing a new issue so we can keep our issue board clean.
|
||||
- Every issue should have exactly one feature request described in it. Please do not file feedback list tickets as it is difficult to parse them and address their individual points.
|
||||
- Feature Requests are better when they’re open-ended instead of demanding a specific solution e.g: “I want an easier way to do X” instead of “add Y”.
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: What is the user problem or growth opportunity you want to see solved?
|
||||
validations:
|
||||
required: false
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: How do you know that this problem exists today? Why is this important?
|
||||
validations:
|
||||
required: false
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Who will benefit from it?
|
||||
validations:
|
||||
required: false
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Anything else you would like to add?
|
||||
validations:
|
||||
required: false
|
||||
46
.github/ISSUE_TEMPLATE/feedback.yml
vendored
Normal file
46
.github/ISSUE_TEMPLATE/feedback.yml
vendored
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
name: "\U0001F4AC Feedback"
|
||||
description: Share your feedback about the app
|
||||
labels: ["feedback"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
- Before creating an issue, please search the existing issues to see if a similar one has already been created.
|
||||
- You can search issues by specific labels (e.g. `label:nearby`) or just by typing keywords into the search filter.
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Feedback
|
||||
description: Share your feedback about the app.
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
attributes:
|
||||
label: Wiki username
|
||||
placeholder: Jimbo Wales
|
||||
validations:
|
||||
required: false
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
# Device information
|
||||
- type: input
|
||||
attributes:
|
||||
label: Device name
|
||||
description: What make and model device did you encounter this on?
|
||||
placeholder: Samsung J7
|
||||
validations:
|
||||
required: false
|
||||
- type: input
|
||||
attributes:
|
||||
label: Android version
|
||||
description: What Android version (e.g., Android 6.0 Marshmallow or Android 11) are you running? Is it the stock version from the manufacturer or a custom ROM ?
|
||||
placeholder: Android 10
|
||||
validations:
|
||||
required: false
|
||||
- type: input
|
||||
attributes:
|
||||
label: Commons app version
|
||||
description: You can find this information by clicking the right-most menu in the bottom navigation bar in the app and tapping 'About'. If you are building from our codebase instead of downloading the app, please also mention the branch and build variant (e.g. `master` and `prodDebug`).
|
||||
placeholder: 3.1.1
|
||||
validations:
|
||||
required: true
|
||||
13
.github/ISSUE_TEMPLATE/need-help.yml
vendored
Normal file
13
.github/ISSUE_TEMPLATE/need-help.yml
vendored
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
name: "✋🏻 Need help"
|
||||
description: Describe the situation which you need help with.
|
||||
labels: ["help needed"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
- Describe the situation which you need help with with as much information as possible.
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Description
|
||||
validations:
|
||||
required: true
|
||||
|
|
@ -1,36 +0,0 @@
|
|||
**Summary:**
|
||||
|
||||
Summarize your issue in one sentence (what goes wrong, what did you expect to happen)
|
||||
|
||||
_Before creating an issue, please search the existing issues to see if a similar one has already been created. You can search issues by specific labels (e.g. `label:nearby`) or just by typing keywords into the search filter._
|
||||
|
||||
**Steps to reproduce:**
|
||||
|
||||
How can we reproduce the issue?
|
||||
What did you expect the app to do, and what did you see instead?
|
||||
|
||||
**System logs:**
|
||||
|
||||
```
|
||||
Add logcat files here (if possible).
|
||||
|
||||
Need help? See https://github.com/commons-app/apps-android-commons/wiki/Getting-app-logs-from-Android-Studio
|
||||
```
|
||||
|
||||
**Device and Android version:**
|
||||
|
||||
What make and model device (e.g., Samsung J7) did you encounter this on?
|
||||
What Android version (e.g., Android 4.0 Ice Cream Sandwich or Android 6.0 Marshmallow) are you running?
|
||||
Is it the stock version from the manufacturer or a custom ROM ?
|
||||
|
||||
**Commons app version:**
|
||||
|
||||
You can find this information by going to the navigation drawer in the app and tapping 'About'. If you are building from our codebase instead of downloading the app, please also mention the branch and build variant (e.g. master and prodDebug).
|
||||
|
||||
**Screen-shots:**
|
||||
|
||||
Can be created by pressing the Volume Down and Power Button at the same time on Android 4.0 and higher.
|
||||
|
||||
**Would you like to work on the issue?**
|
||||
|
||||
Please let us know whether you want to fix the issue by yourself. If not, anyone can get the issue assigned to them.
|
||||
Loading…
Add table
Add a link
Reference in a new issue