Skip to content

Crawlee—A web scraping and browser automation library for Node.js to build reliable crawlers. In JavaScript and TypeScript. Extract data for AI, LLMs, RAG, or GPTs. Download HTML, PDF, JPG, PNG, and other files from websites. Works with Puppeteer, Playwright, Cheerio, JSDOM, and raw HTTP. Both headful and headless mode. With proxy rotation.

docs: new GitHub issue forms (#1552)

Vlad Frangu0aeca50feb05
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index bddc0960c..000000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,27 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: bug
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Add an example of code that produces the problem you're reporting.
-We should be able to copy your code, run it and get the same result.
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**System information:**
- - OS: [e.g. MacOS]
- - Node.js version [e.g. 14.7]
- - Crawlee version [e.g. 3.0.4]
- - Apify platform [yes or no]
-
-**Additional context**
-Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 000000000..ea78bd914
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,122 @@
+name: Bug report
+description: Report incorrect or unexpected behavior of a module
+labels: [bug]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ If you have a question, please ask it on [GitHub Discussions](https://github.com/apify/crawlee/discussions) or in our [Discord server](https://discord.gg/jyEM2PRvMU)
+
+ - type: dropdown
+ id: package
+ attributes:
+ label: Which package is this bug report for? If unsure which one to select, select `crawlee`
+ multiple: false
+ options:
+ - "crawlee"
+ - "@crawlee/core"
+ - "@crawlee/cheerio (CheerioCrawler)"
+ - "@crawlee/jsdom (JSDOMCrawler)"
+ - "@crawlee/playwright (PlaywrightCrawler)"
+ - "@crawlee/puppeteer (PuppeteerCrawler)"
+ - "@crawlee/basic (BasicCrawler)"
+ - "@crawlee/http (HttpCrawler)"
+ - "@crawlee/browser (BrowserCrawler)"
+ - "@crawlee/utils"
+ - "@crawlee/browser-pool"
+ - "@crawlee/memory-storage"
+ validations:
+ required: true
+
+ - type: textarea
+ id: description
+ attributes:
+ label: Issue description
+ description: |
+ Describe the issue in as much detail as possible.
+
+ Tip: You can attach images or log files by clicking this area to highlight it and then dragging files into it.
+ placeholder: |
+ Steps to reproduce with the code sample below:
+ 1. do thing
+ 2. call x method
+ 3. observe behavior
+ 4. see error logs below
+ validations:
+ required: true
+
+ - type: textarea
+ id: codesample
+ attributes:
+ label: Code sample
+ description: Include a reproducible, minimal code sample. This will be automatically formatted into code, so no need for backticks.
+ render: TypeScript
+ placeholder: |
+ // Your code sample should be...
+ // ... Minimal - use as little code as possible that still produces the same problem (and is understandable)
+ // ... Complete - Provide all parts someone else needs to reproduce your problem
+ // ... Reproducible - Test the code you're about to provide to make sure it reproduces the problem
+
+ - type: input
+ id: package-version
+ attributes:
+ label: Package version
+ description: Which version of the package are you using? Run `npm list <package>` in your project directory and paste the output.
+ validations:
+ required: true
+
+ - type: input
+ id: node-version
+ attributes:
+ label: Node.js version
+ description: |
+ Which version of Node.js are you using? Run `node --version` in your project directory and paste the output.
+ If you are using TypeScript, please include its version (`npm list typescript`) as well.
+ placeholder: Node.js version 16+ is required for Crawlee
+ validations:
+ required: true
+
+ - type: input
+ id: os
+ attributes:
+ label: Operating system
+ description: Which OS does your application run on?
+
+ - type: dropdown
+ id: apify
+ attributes:
+ label: Apify platform
+ description: Did you also encounter this issue when running your code on Apify's platform? (if unsure what that is, leave unfilled)
+ multiple: false
+ options:
+ - "Yes"
+ - "No"
+
+ - type: dropdown
+ id: priority
+ attributes:
+ label: Priority this issue should have
+ description: Make sure you choose something that makes sense! If you need to elaborate on your reasoning, please do so in the Issue description section.
+ multiple: false
+ options:
+ - "Low (slightly annoying)"
+ - "Medium (should be fixed soon)"
+ - "High (immediate attention needed)"
+ validations:
+ required: true
+
+ - type: input
+ id: next-release
+ attributes:
+ label: I have tested this on the `next` release
+ description: |
+ This issue might already be fixed in a development release (tagged as `next` on npm). This is not required, but it helps us greatly.
+ To install the latest development release run `npm i <package>@next` in your project directory.
+ Run `npm list <package>` and provide the full version that is printed.
+ placeholder: 3.0.5-beta.50
+
+ - type: textarea
+ id: additional-context
+ attributes:
+ label: Other context
+ description: Any other context, screenshots, or file uploads that help us understand your bug report.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 000000000..e079dbe62
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,12 @@
+blank_issues_enabled: false
+contact_links:
+ - name: GitHub Discussions
+ url: https://github.com/apify/crawlee/discussions
+ about: Got a question? Want to leave some feedback for the Crawlee team? Make a post in GitHub Discussions about it!
+ - name: Discord
+ url: https://discord.gg/jyEM2PRvMU
+ about: Join our Discord server where you can talk with the Crawlee community, as well as the Apify team and get help if you have a question or are unsure of how to do something!
+ - name: Crawlee Documentation
+ url: https://crawlee.dev
+ about: Check out Crawlee's documentation, maybe you'll find your solution there!
+
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
deleted file mode 100644
index f471102c3..000000000
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ /dev/null
@@ -1,17 +0,0 @@
----
-name: Feature request
-about: For new things and improvements that are not bugs.
-title: ''
-labels: feature
-assignees: ''
-
----
-
-**Describe the feature**
-A clear and concise description of what feature you're requesting.
-
-**Motivation**
-Why would you like to have this feature in Crawlee. How would you use it? How would it help you?
-
-**Constraints**
-Are there any requirements or limits to the feature that need to be satisfied?
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
new file mode 100644
index 000000000..133308c36
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,61 @@
+name: Feature request
+description: Request a new feature in Crawlee
+labels: [feature]
+body:
+ - type: dropdown
+ id: package
+ attributes:
+ label: Which package is the feature request for? If unsure which one to select, select `crawlee`
+ multiple: false
+ options:
+ - "crawlee"
+ - "@crawlee/core"
+ - "@crawlee/cheerio (CheerioCrawler)"
+ - "@crawlee/jsdom (JSDOMCrawler)"
+ - "@crawlee/playwright (PlaywrightCrawler)"
+ - "@crawlee/puppeteer (PuppeteerCrawler)"
+ - "@crawlee/basic (BasicCrawler)"
+ - "@crawlee/http (HttpCrawler)"
+ - "@crawlee/browser (BrowserCrawler)"
+ - "@crawlee/utils"
+ - "@crawlee/browser-pool"
+ - "@crawlee/memory-storage"
+ validations:
+ required: true
+
+ - type: textarea
+ id: description
+ attributes:
+ label: Feature
+ description: A clear and concise description of what the problem is, or what feature you want to be implemented.
+ placeholder: I'm always frustrated when..., I would love if there was a shortcut for..., A good addition would be...
+ validations:
+ required: true
+
+ - type: textarea
+ id: motive
+ attributes:
+ label: Motivation
+ description: What made you want to suggest this feature? How would you use it in Crawlee and how will it help you?
+ validations:
+ required: true
+
+ - type: textarea
+ id: solution
+ attributes:
+ label: Ideal solution or implementation, and any additional constraints
+ description: What constraints would we need to ensure? How do you see this feature implemented or used by you?
+ validations:
+ required: true
+
+ - type: textarea
+ id: alternatives
+ attributes:
+ label: Alternative solutions or implementations
+ description: Have you considered any alternative solutions or features that would help you with this issue?
+
+ - type: textarea
+ id: additional-context
+ attributes:
+ label: Other context
+ description: Any other context, screenshots, or file uploads that help us understand your feature request.
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
deleted file mode 100644
index a711f4f1d..000000000
--- a/.github/ISSUE_TEMPLATE/question.md
+++ /dev/null
@@ -1,16 +0,0 @@
----
-name: Question
-about: When you need help with something.
-title: ''
-labels: question
-assignees: ''
-
----
-
-For questions and help, prefer using either [Discussions](https://github.com/apify/crawlee/discussions) or join [Crawlee Discord](https://discord.gg/jyEM2PRvMU). The Crawlee community and Apify team members are there to help you.
-
-Please also make sure that you visit all the relevant information sources and search there for answers first.
-
-- [Crawlee Documentation](https://crawlee.dev/)
-- [Apify/Crawlee Academy](https://stackoverflow.com/tags/apify/) - A lot of tutorials there work with Crawlee-only setup (no Apify SDK or Apify platform required)
-- [Apify Platform Docs](https://docs.apify.com)