Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a new form-based bug report issue template #431

Merged
merged 1 commit into from
Jan 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 0 additions & 68 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

57 changes: 57 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: Bug report
description: File a bug report to help improve the Readium toolkit
title: "[Bug] "
labels: ["bug", "triage"]
body:
- type: markdown
attributes:
value: |
Thank you for filing a bug report! Please [search for existing issues](https://github.com/readium/kotlin-toolkit/issues?q=is:issue) before submitting.
- type: textarea
id: bug-description
attributes:
label: Describe the bug
description: Also, please let us know what your expectations were.
placeholder: A clear and concise description of what the bug is.
validations:
required: true
- type: textarea
id: bug-steps
attributes:
label: How to reproduce?
description: |
Step by step explanation to reproduce the issue in the Test App.

If you can, drag and drop:
- the publication used to reproduce the problem, after zipping it.
- screenshots or a screencast showing the issue

placeholder: |
1. Open book X
2. Go to chapter Y
3. Swipe left twice
4. See error
...
validations:
required: true
- type: input
id: bug-readium-version
attributes:
label: Readium version
description: What version of the Readium toolkit are you running?
validations:
required: true
- type: input
id: bug-api-version
attributes:
label: Android API version
description: On which Android API version(s) did you reproduce the problem?
validations:
required: true
- type: textarea
id: bug-additional
attributes:
label: Additional context
description: |
Share additional code showing how you use Readium, if relevant. Output logs are useful as well.
If you already went through the codebase to find the bug, you can explain your findings here.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
Loading