From 8896092e3126e3ebe953ea87505c1dad08ff143b Mon Sep 17 00:00:00 2001 From: Harald Kuhr Date: Fri, 7 May 2021 19:29:52 +0200 Subject: [PATCH] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 59 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++ 2 files changed, 79 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..75e0754a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,59 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: Trouble-shooting +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**TwelveMonkeys ImageIO version** +The version of the library in use. + +For example: + + 4.0.0 + +**Java version** +The *exact* output of `java --version` (or `java -version` for older Java releases). + +For example: + + java version "1.8.0_271" + Java(TM) SE Runtime Environment (build 1.8.0_271-b09) + Java HotSpot(TM) 64-Bit Server VM (build 25.271-b09, mixed mode) + +**Environment info** +Extra information about OS version, server version, standalone program or web application packaging, executable wrapper, etc. Please state exact version numbers where applicable. + +**To Reproduce** +Steps to reproduce the behavior: + +1. Compile the below sample code +2. Download the sample image file +3. Run the code with the sample file +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Example code** +Preferably as a failing JUnit test, or a standalone program with a `main` method that showcases the problem. + +Less is more. Don't add your entire project, only the code required to reproduce the problem. 😀 + +**Sample file** +Attach any sample files needed to reproduce the problem. Use a ZIP-file if the format is not directly supported by GitHub. + +**Stak trace** +Always include the stack trace you experience. + +**Screenshots** +If applicable, add screenshots to help explain your problem. +Do not add screenshots of code or stack traces. 😀 + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..27a73dd5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem or use case is. + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**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, like links to specifications or sample files.