From b6a65a9b1a586600192fb37c9d5f6525af375268 Mon Sep 17 00:00:00 2001 From: Luca Foppiano Date: Mon, 30 Sep 2024 04:38:49 +0900 Subject: [PATCH] improve issue template (#1174) --- .github/ISSUE_TEMPLATE/general-report.md | 46 ++++++++++++++++++------ 1 file changed, 36 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/general-report.md b/.github/ISSUE_TEMPLATE/general-report.md index 85ac8935b5..432d286e66 100644 --- a/.github/ISSUE_TEMPLATE/general-report.md +++ b/.github/ISSUE_TEMPLATE/general-report.md @@ -1,15 +1,41 @@ ---- name: General report about: Create a report to help us improve title: '' labels: '' assignees: '' ---- - -Before creating a new issue, make sure you had a look at the [official documentation](https://grobid.readthedocs.com). For specific questions, you can try the [Mendable Q/A chat](https://www.mendable.ai/demo/723cfc12-fdd6-4631-9a9e-21b80241131b) (**NOTE**: This is rather experimental, if not sure, make sure you double-check using the official documentation.) - -- What is your OS and architecture? Windows is not supported and Mac OS arm64 is experimentally supported. For non-supported OS, you can use Docker (https://grobid.readthedocs.io/en/latest/Grobid-docker/) - -- What is your Java version (`java --version`)? - -- In case of build or run errors, please submit the error while running gradlew with ``--stacktrace`` and ``--info`` for better log traces (e.g. `./gradlew run --stacktrace --info`) or attach the log file `logs/grobid-service.log` or the console log. +assignees: +- type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! Before creating a new issue, make sure you had a look at the [official documentation](https://grobid.readthedocs.com) or with the **experimental** [Mendable Q/A chat](https://www.mendable.ai/demo/723cfc12-fdd6-4631-9a9e-21b80241131b). **NOTE**: the suggested method of running grobid is through Docker (https://grobid.readthedocs.io/en/latest/Grobid-docker/). +- type: input + id: os + attributes: + label: Operating System and architecture (arm64, amd64, x86, etc.) + description: Please remember that Windows is not supported and Mac OS arm64 is still experimental. + validations: + required: false +- type: input + id: java + attributes: + label: What is your Java version + description: `java --version` + validations: + required: false +- type: logs + id: java + attributes: + label: Log and information + description: In case of build or run errors, please submit the error while running gradlew with ``--stacktrace`` and ``--info`` for better log traces (e.g. `./gradlew run --stacktrace --info`) or attach the log file `logs/grobid-service.log` or the console log. + validations: + required: false +- type: textarea + id: what-happened + attributes: + label: + description: Please give us any information that could be of help + placeholder: Tell us what you see! + value: '' + validations: + required: false +