From d4d4d99b9cc03bf0691f5a5c35b190f37b23ea30 Mon Sep 17 00:00:00 2001 From: Sefik Ilkin Serengil Date: Sun, 21 Apr 2024 14:14:54 +0100 Subject: [PATCH] pre check to report a bug --- .github/ISSUE_TEMPLATE/01-report-bug.yaml | 10 ++++++++++ README.md | 4 ---- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/01-report-bug.yaml b/.github/ISSUE_TEMPLATE/01-report-bug.yaml index e7e7a4b..55d3382 100644 --- a/.github/ISSUE_TEMPLATE/01-report-bug.yaml +++ b/.github/ISSUE_TEMPLATE/01-report-bug.yaml @@ -4,6 +4,16 @@ title: '[BUG]: ' labels: - bug body: + - type: checkboxes + id: preliminary-checks + attributes: + label: Before You Report a Bug, Please Confirm You Have Done The Following... + description: If any of these required steps are not taken, we may not be able to review your issue. Help us to help you! + options: + - label: I have updated to the latest version of the packages. + required: true + - label: I have searched for both [existing issues](https://github.com/serengil/deepface/issues) and [closed issues](https://github.com/serengil/deepface/issues?q=is%3Aissue+is%3Aclosed) and found none that matched my issue. + required: true - type: input id: deepface-version attributes: diff --git a/README.md b/README.md index 11f4613..016c5de 100644 --- a/README.md +++ b/README.md @@ -316,10 +316,6 @@ $ deepface analyze -img_path tests/dataset/img1.jpg You can also run these commands if you are running deepface with docker. Please follow the instructions in the [shell script](https://github.com/serengil/deepface/blob/master/scripts/dockerize.sh#L17). -## FAQ and Troubleshooting - -If you believe you have identified a bug or encountered a limitation in DeepFace that is not covered in the [existing issues](https://github.com/serengil/deepface/issues) or [closed issues](https://github.com/serengil/deepface/issues?q=is%3Aissue+is%3Aclosed), kindly open a new issue. Ensure that your submission includes clear and detailed reproduction steps, such as your Python version, your DeepFace version, versions of dependent packages (provided by pip freeze), specifics of any exception messages, details about how you are calling DeepFace, and the input image(s) you are using. - ## Contribution Pull requests are more than welcome! If you are planning to contribute a large patch, please create an issue first to get any upfront questions or design decisions out of the way first.