From 918f897243c3bf45325e715417d9a5364cb51008 Mon Sep 17 00:00:00 2001
From: Hristo Harsev <hhursev@gmail.com>
Date: Fri, 27 Dec 2024 19:19:48 +0200
Subject: [PATCH] Revamp GitHub issue templates

- Enforce usage of templates by disabling blank issues
- Add 4 streamlined templates:
  - New website requests
  - Website bug reports
  - Show and tell (with link to #9)
  - Generic template for other issues
- Collect optional feedback about package usage and discovery
---
 .github/ISSUE_TEMPLATE/1_issue_new_webiste.md | 23 ++++++++++++++++
 .github/ISSUE_TEMPLATE/2_issue_website_bug.md | 26 ++++++++++++++++++
 .../ISSUE_TEMPLATE/3_issue_show_and_tell.md   | 15 +++++++++++
 .github/ISSUE_TEMPLATE/4_issue_other.md       | 19 +++++++++++++
 .github/ISSUE_TEMPLATE/config.yaml            |  1 +
 .github/ISSUE_TEMPLATE/config.yml             |  1 -
 .github/ISSUE_TEMPLATE/new_scraper.md         | 13 ---------
 .github/ISSUE_TEMPLATE/scraper_bug_report.md  | 27 -------------------
 8 files changed, 84 insertions(+), 41 deletions(-)
 create mode 100644 .github/ISSUE_TEMPLATE/1_issue_new_webiste.md
 create mode 100644 .github/ISSUE_TEMPLATE/2_issue_website_bug.md
 create mode 100644 .github/ISSUE_TEMPLATE/3_issue_show_and_tell.md
 create mode 100644 .github/ISSUE_TEMPLATE/4_issue_other.md
 create mode 100644 .github/ISSUE_TEMPLATE/config.yaml
 delete mode 100644 .github/ISSUE_TEMPLATE/config.yml
 delete mode 100644 .github/ISSUE_TEMPLATE/new_scraper.md
 delete mode 100644 .github/ISSUE_TEMPLATE/scraper_bug_report.md

diff --git a/.github/ISSUE_TEMPLATE/1_issue_new_webiste.md b/.github/ISSUE_TEMPLATE/1_issue_new_webiste.md
new file mode 100644
index 000000000..df2d31eaa
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/1_issue_new_webiste.md
@@ -0,0 +1,23 @@
+---
+name: New website
+about: Request support for a new recipe website
+title: "I'd like to request support for <website>"
+labels: enhancement
+assignees: ''
+
+---
+
+Please verify the website is not listed in: https://docs.recipe-scrapers.com/getting-started/supported-sites/
+
+Sample recipe URLs:
+- https://
+- https://
+
+
+<!-- Optional information that helps us understand our users better:
+- Which version of recipe-scrapers are you using?
+- How did you discover the package?
+- What's your use case for recipe-scrapers?
+
+Feel free to delete this section.
+-->
diff --git a/.github/ISSUE_TEMPLATE/2_issue_website_bug.md b/.github/ISSUE_TEMPLATE/2_issue_website_bug.md
new file mode 100644
index 000000000..53b2417df
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/2_issue_website_bug.md
@@ -0,0 +1,26 @@
+---
+name: Scraper bug
+about: Report an issue with an existing scraper
+title: "Scraper issue with <website>"
+labels: bug
+assignees: ''
+
+---
+
+Recipe URL with the issue:
+- https://
+
+
+Which data is not being scraped correctly?
+(e.g. ingredients, instructions, etc):
+
+What should be shown instead?
+
+
+<!-- Optional information that helps us understand our users better:
+- Which version of recipe-scrapers are you using?
+- How did you discover the package?
+- What's your use case for recipe-scrapers?
+
+Feel free to delete this section.
+-->
diff --git a/.github/ISSUE_TEMPLATE/3_issue_show_and_tell.md b/.github/ISSUE_TEMPLATE/3_issue_show_and_tell.md
new file mode 100644
index 000000000..77ab19c82
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/3_issue_show_and_tell.md
@@ -0,0 +1,15 @@
+---
+name: Show and tell
+about: Share what you've built using recipe-scrapers
+title: "Built with recipe-scrapers: <project name>"
+labels: show-and-tell
+assignees: ''
+
+---
+
+Tell us about your project built with recipe-scrapers!
+
+You can also share it as a comment in https://github.com/hhursev/recipe-scrapers/issues/9.
+
+Project details:
+<!-- Share whatever you're comfortable with - a description, links, screenshots, etc. -->
diff --git a/.github/ISSUE_TEMPLATE/4_issue_other.md b/.github/ISSUE_TEMPLATE/4_issue_other.md
new file mode 100644
index 000000000..9c2a57114
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/4_issue_other.md
@@ -0,0 +1,19 @@
+---
+name: Other
+about: For questions and issues that don't fit other categories
+title: ""
+labels: ''
+assignees: ''
+
+---
+
+<!-- Describe your question or issue here -->
+
+
+<!-- Optional information that helps us understand our users better:
+- Which version of recipe-scrapers are you using?
+- How did you discover the package?
+- What's your use case for recipe-scrapers?
+
+Feel free to delete this section.
+-->
diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml
new file mode 100644
index 000000000..3ba13e0ce
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yaml
@@ -0,0 +1 @@
+blank_issues_enabled: false
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
deleted file mode 100644
index 0086358db..000000000
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ /dev/null
@@ -1 +0,0 @@
-blank_issues_enabled: true
diff --git a/.github/ISSUE_TEMPLATE/new_scraper.md b/.github/ISSUE_TEMPLATE/new_scraper.md
deleted file mode 100644
index 9b4160a3b..000000000
--- a/.github/ISSUE_TEMPLATE/new_scraper.md
+++ /dev/null
@@ -1,13 +0,0 @@
----
-name: New website scraper request
-about: Add support for a new recipe website
-title: ''
-labels: enhancement
-assignees: ''
-
----
-
-Please check that recipes published on the website you're requesting are public (we can't currently scrape recipes that require an account login), and add sample recipe URL(s) below:
-
-- https:// ...
-- https:// ...
diff --git a/.github/ISSUE_TEMPLATE/scraper_bug_report.md b/.github/ISSUE_TEMPLATE/scraper_bug_report.md
deleted file mode 100644
index 9c7310184..000000000
--- a/.github/ISSUE_TEMPLATE/scraper_bug_report.md
+++ /dev/null
@@ -1,27 +0,0 @@
----
-name: Scraper bug report
-about: Report a scraper that is not working correctly
-title: ''
-labels: bug
-assignees: ''
-
----
-
-**Pre-filing checks**:
-
-- [ ] I have searched for open issues that report the same problem
-- [ ] I have checked that the bug affects the latest version of the library
-
-**The URL of the recipe(s) that are not being scraped correctly**:
-
-- https:// ...
-
-...
-
-**The results you expect to see**:
-
-...
-
-**The results (including any Python error messages) that you are seeing**:
-
-...