From e4b884e150c302447f25dc9d67dded4762b50385 Mon Sep 17 00:00:00 2001 From: Acclorite <140836141+Acclorite@users.noreply.github.com> Date: Mon, 12 Aug 2024 23:28:43 +0300 Subject: [PATCH] =?UTF-8?q?=F0=9F=9A=80=20Add=20issue=20templates?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Added issue templates for users to use when submitting errors. This will ensure consistency of Issues and solving issues more quickly due to more clear description. --- .github/ISSUE_TEMPLATE/book-parser-issue.md | 26 +++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 35 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 23 ++++++++++++++ 3 files changed, 84 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/book-parser-issue.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.md diff --git a/.github/ISSUE_TEMPLATE/book-parser-issue.md b/.github/ISSUE_TEMPLATE/book-parser-issue.md new file mode 100644 index 00000000..37082a73 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/book-parser-issue.md @@ -0,0 +1,26 @@ +--- +name: Book parser issue +about: Report an issue with parser +title: '' +labels: "\U0001F3BC Parser issue" +assignees: Acclorite + +--- + +**Where it happened?** +Describe where issue with the parser occurred, for example: "Issue occurred at 40.1%" or "Could not add this book because of error in Browse Screen". + +**Short description of what is wrong** +Describe in short the problem, for example: "Weird line break" or "App says file is empty when it is not". + +**Attach problematic file (necessary!)** +Attach the file you had problems with. This step is necessary, without it issue may be closed, if no appropriate reason given. + +**Screenshots (optional)** +If applicable, add screenshots to help explain your problem. + +**Additional context (optional)** +Any additional info you may want to give. + +Please don't use titles like [Parser Issue], use clear and well formatted titles like "Error with parsing book [Book Name].[File Format]". +Duplicates and invalid issues will be closed. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..04f63503 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,35 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: "\U0001F47E Bug" +assignees: Acclorite + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots (optional)** +If applicable, add screenshots to help explain your problem. + +**Device Info (please complete the following information):** + - Device: [e.g. Pixel 8] + - Android Version: [e.g. 14] + - Version of the app [e.g. v1.1.0] + +**Additional context (optional)** +Add any other context about the problem here. + +Please don't use titles like [Bug], use clear and well formatted titles like "Some error in Screen". +Duplicates and invalid issues will be closed. diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 00000000..4fe280d3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,23 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: "\U0001F680 Feature request" +assignees: Acclorite + +--- + +**Why you want this feature to be implemented? Please describe.** +Describe why you'd like to see this feature in the app. + +**Describe the feature you'd like to be implemented** +Describe as good as you can how you would like this feature to be implemented and idea behind it. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. + +Please don't use titles like [Feature Request], use clear and well formatted titles like "New feature in Screen". +Duplicates and invalid issues will be closed.