diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 9b461e4a09..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -## Bug Report - - - -### What happened? - - - -### Expected behavior - - - -### How to reproduce? - - - -### Environment - - - -* Readium version: - -#### Development environment - -* OS: -* IDE: - -#### Testing device - -* Android version: -* Model: -* Is it an emulator? Yes or No - -### Additional context - -* Are you willing to fix the problem and contribute a pull request? Yes or No - - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000000..af46ab6cdd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..ec4bb386bc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false \ No newline at end of file