Skip to content

Commit

Permalink
Revamp GitHub issue templates
Browse files Browse the repository at this point in the history
- 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
  • Loading branch information
hhursev committed Dec 27, 2024
1 parent 089c7af commit 918f897
Show file tree
Hide file tree
Showing 8 changed files with 84 additions and 41 deletions.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/1_issue_new_webiste.md
Original file line number Diff line number Diff line change
@@ -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.
-->
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/2_issue_website_bug.md
Original file line number Diff line number Diff line change
@@ -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.
-->
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/3_issue_show_and_tell.md
Original file line number Diff line number Diff line change
@@ -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. -->
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/4_issue_other.md
Original file line number Diff line number Diff line change
@@ -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.
-->
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/config.yml

This file was deleted.

13 changes: 0 additions & 13 deletions .github/ISSUE_TEMPLATE/new_scraper.md

This file was deleted.

27 changes: 0 additions & 27 deletions .github/ISSUE_TEMPLATE/scraper_bug_report.md

This file was deleted.

0 comments on commit 918f897

Please sign in to comment.