From 0a91eb5732bfa249548b4ddf7aa9ff3618401b00 Mon Sep 17 00:00:00 2001 From: Borewit Date: Tue, 10 Sep 2024 20:58:22 +0200 Subject: [PATCH 1/2] Add an issue template to discourage false issues being raised --- .github/ISSUE_TEMPLATE/issue.yml | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/issue.yml diff --git a/.github/ISSUE_TEMPLATE/issue.yml b/.github/ISSUE_TEMPLATE/issue.yml new file mode 100644 index 00000000..585b0c8b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue.yml @@ -0,0 +1,26 @@ +name: Bug Report +description: Use this template to report bugs or issues. +body: + - type: checkboxes + attributes: + label: Existing Issue Check + description: Please search for existing issues to avoid duplicates. + options: + - label: "I have searched the existing issues and could not find any related to my problem." + required: true + + - type: checkboxes + attributes: + label: ESM (ECMAScript Module) Requirement Acknowledgment + description: File-type is an ECMAScript Module (ESM) only. CommonJS is **not** supported. + options: + - label: "My project is an ESM project, and my `package.json` contains the following entry: `\"type\": \"module\"`." + required: true + + - type: checkboxes + attributes: + label: File-Type Scope Acknowledgment + description: File-type is designed to detect well-known **binary**-based file types only. + options: + - label: "I understand that file-type detects binary file types and not text or other formats." + required: true From 3d1806be7cfb30d12a3d349df54f9418f29c6c52 Mon Sep 17 00:00:00 2001 From: Sindre Sorhus Date: Thu, 12 Sep 2024 13:58:34 +0700 Subject: [PATCH 2/2] Update issue.yml --- .github/ISSUE_TEMPLATE/issue.yml | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/issue.yml b/.github/ISSUE_TEMPLATE/issue.yml index 585b0c8b..a5d8f74c 100644 --- a/.github/ISSUE_TEMPLATE/issue.yml +++ b/.github/ISSUE_TEMPLATE/issue.yml @@ -1,26 +1,24 @@ name: Bug Report -description: Use this template to report bugs or issues. +description: Report bugs or issues. body: - type: checkboxes attributes: label: Existing Issue Check description: Please search for existing issues to avoid duplicates. options: - - label: "I have searched the existing issues and could not find any related to my problem." + - label: 'I have searched the existing issues and could not find any related to my problem.' required: true - - type: checkboxes attributes: label: ESM (ECMAScript Module) Requirement Acknowledgment - description: File-type is an ECMAScript Module (ESM) only. CommonJS is **not** supported. + description: This package is an ECMAScript Module (ESM) only. CommonJS is **not** supported. options: - - label: "My project is an ESM project, and my `package.json` contains the following entry: `\"type\": \"module\"`." + - label: 'My project is an [ESM project](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c) and my `package.json` contains the following entry: `"type": "module"`.' required: true - - type: checkboxes attributes: label: File-Type Scope Acknowledgment - description: File-type is designed to detect well-known **binary**-based file types only. + description: This package is designed to detect well-known **binary**-based file types only. options: - - label: "I understand that file-type detects binary file types and not text or other formats." + - label: 'I understand that file-type detects binary file types and not text or other formats.' required: true