From 1ab9d115cf5632b229446b727a77850bfcece413 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C5=8Dnin=20bingi?= <42009541+mcam10@users.noreply.github.com> Date: Mon, 13 Jan 2025 04:23:52 -0800 Subject: [PATCH 1/3] Fixing minor typos in README (#440) @mcam10 Thx for the support. Appreciate --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index af55c22d..7ab02b10 100644 --- a/README.md +++ b/README.md @@ -432,7 +432,7 @@ if __name__ == "__main__":
-🤖 Using You own Browswer with Custome User Profile +🤖 Using You own Browser with Custom User Profile ```python import os, sys From 8878b3d032fb21ce3567b34db128bfa64687198a Mon Sep 17 00:00:00 2001 From: devatbosch Date: Mon, 13 Jan 2025 18:27:31 +0530 Subject: [PATCH 2/3] Updated the correct link for "Contribution guidelines" in README.md (#445) Thank you for pointing this out. I am creating a contributing guide, which is why I changed the name to the contributors, but I forgot to update some other places. Thanks again. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7ab02b10..dbccf547 100644 --- a/README.md +++ b/README.md @@ -511,7 +511,7 @@ To check our development plans and upcoming features, visit our [Roadmap](https: ## 🤝 Contributing -We welcome contributions from the open-source community. Check out our [contribution guidelines](https://github.com/unclecode/crawl4ai/blob/main/CONTRIBUTING.md) for more information. +We welcome contributions from the open-source community. Check out our [contribution guidelines](https://github.com/unclecode/crawl4ai/blob/main/CONTRIBUTORS.md) for more information. ## 📄 License From 6dfa9cb703231d0bd8a3c9b5e4ce527efae415ef Mon Sep 17 00:00:00 2001 From: Aravind Date: Sun, 19 Jan 2025 14:23:03 +0530 Subject: [PATCH 3/3] Streamline Feature requests, bug reports and Forums with Forms & Templates (#465) * config:Add bug report template and issue chooser * config:Add bug report template and issue chooser * config:Add bug report template and issue chooser * config:Add bug report template and issue chooser * config:Add bug report template and issue chooser * config:Add bug report template and issue chooser * config: updated new bugs to have needs-triage label by default * Template for PR * Template for PR * Template for PR * Template for PR * Added FR template * Added FR template * Added FR template * Added FR template * Config: updated the text for new labels * config: changed the order of steps to reproduce * Config: shortened the form for feature request * Config: Added a code snippet section to the bug report --- .../DISCUSSION_TEMPLATE/feature-requests.yml | 59 ++++++++ .github/ISSUE_TEMPLATE/bug_report.yml | 127 ++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 ++ .github/pull_request_template.md | 19 +++ 4 files changed, 213 insertions(+) create mode 100644 .github/DISCUSSION_TEMPLATE/feature-requests.yml create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/pull_request_template.md diff --git a/.github/DISCUSSION_TEMPLATE/feature-requests.yml b/.github/DISCUSSION_TEMPLATE/feature-requests.yml new file mode 100644 index 00000000..24c21565 --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/feature-requests.yml @@ -0,0 +1,59 @@ +title: "[Feature Request]: " +labels: ["⚙️ New"] +body: + - type: markdown + attributes: + value: | + Thank you for your interest in suggesting a new feature! Before you submit, please take a moment to check if already exists in + this discussions category to avoid duplicates. 😊 + + - type: textarea + id: needs_to_be_done + attributes: + label: What needs to be done? + description: Please describe the feature or functionality you'd like to see. + placeholder: "e.g., Return alt text along with images scraped from a webpages in Result" + validations: + required: true + + - type: textarea + id: problem_to_solve + attributes: + label: What problem does this solve? + description: Explain the pain point or issue this feature will help address. + placeholder: "e.g., Bypass Captchas added by cloudflare" + validations: + required: true + + - type: textarea + id: target_users + attributes: + label: Target users/beneficiaries + description: Who would benefit from this feature? (e.g., specific teams, developers, users, etc.) + placeholder: "e.g., Marketing teams, developers" + validations: + required: false + + - type: textarea + id: current_workarounds + attributes: + label: Current alternatives/workarounds + description: Are there any existing solutions or workarounds? How does this feature improve upon them? + placeholder: "e.g., Users manually select the css classes mapped to data fields to extract them" + validations: + required: false + + - type: markdown + attributes: + value: | + ### 💡 Implementation Ideas + + - type: textarea + id: proposed_approach + attributes: + label: Proposed approach + description: Share any ideas you have for how this feature could be implemented. Point out any challenges your foresee + and the success metrics for this feature + placeholder: "e.g., Implement a breadth first traversal algorithm for scraper" + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..0ff926be --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,127 @@ +name: Bug Report +description: Report a bug with the Crawl4AI. +title: "[Bug]: " +labels: ["🐞 Bug","🩺 Needs Triage"] +body: + - type: input + id: crawl4ai_version + attributes: + label: crawl4ai version + description: Specify the version of crawl4ai you are using. + placeholder: "e.g., 2.0.0" + validations: + required: true + + - type: textarea + id: expected_behavior + attributes: + label: Expected Behavior + description: Describe what you expected to happen. + placeholder: "Provide a detailed explanation of the expected outcome." + validations: + required: true + + - type: textarea + id: current_behavior + attributes: + label: Current Behavior + description: Describe what is happening instead of the expected behavior. + placeholder: "Describe the actual result or issue you encountered." + validations: + required: true + + - type: dropdown + id: reproducible + attributes: + label: Is this reproducible? + description: Indicate whether this bug can be reproduced consistently. + options: + - "Yes" + - "No" + validations: + required: true + + - type: textarea + id: inputs + attributes: + label: Inputs Causing the Bug + description: Provide details about the inputs causing the issue. + placeholder: | + - URL(s): + - Settings used: + - Input data (if applicable): + render: bash + + - type: textarea + id: steps_to_reproduce + attributes: + label: Steps to Reproduce + description: Provide step-by-step instructions to reproduce the issue. + placeholder: | + 1. Go to... + 2. Click on... + 3. Observe the issue... + render: bash + + - type: textarea + id: code_snippets + attributes: + label: Code snippets + description: Provide code snippets(if any). Add comments as necessary + placeholder: print("Hello world") + render: python + + # Header Section with Title + - type: markdown + attributes: + value: | + ## Supporting Information + Please provide the following details to help us understand and resolve your issue. This will assist us in reproducing and diagnosing the problem + + - type: input + id: os + attributes: + label: OS + description: Please provide the operating system & distro where the issue occurs. + placeholder: "e.g., Windows, macOS, Linux" + validations: + required: true + + - type: input + id: python_version + attributes: + label: Python version + description: Specify the Python version being used. + placeholder: "e.g., 3.8.5" + validations: + required: true + + # Browser Field + - type: input + id: browser + attributes: + label: Browser + description: Provide the name of the browser you are using. + placeholder: "e.g., Chrome, Firefox, Safari" + validations: + required: false + + # Browser Version Field + - type: input + id: browser_version + attributes: + label: Browser version + description: Provide the version of the browser you are using. + placeholder: "e.g., 91.0.4472.124" + validations: + required: false + + # Error Logs Field (Text Area) + - type: textarea + id: error_logs + attributes: + label: Error logs & Screenshots (if applicable) + description: If you encountered any errors, please provide the error logs. Attach any relevant screenshots to help us understand the issue. + placeholder: "Paste error logs here and attach your screenshots" + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..5f877d13 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Feature Requests + url: https://github.com/unclecode/crawl4ai/discussions/categories/feature-requests + about: "Suggest new features or enhancements for Crawl4AI" + - name: Forums - Q&A + url: https://github.com/unclecode/crawl4ai/discussions/categories/forums-q-a + about: "Ask questions or engage in general discussions about Crawl4AI" diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..7366dad4 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,19 @@ +## Summary +Please include a summary of the change and/or which issues are fixed. + +eg: `Fixes #123` (Tag GitHub issue numbers in this format, so it automatically links the issues with your PR) + +## List of files changed and why +eg: quickstart.py - To update the example as per new changes + +## How Has This Been Tested? +Please describe the tests that you ran to verify your changes. + +## Checklist: + +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] I have added/updated unit tests that prove my fix is effective or that my feature works +- [ ] New and existing unit tests pass locally with my changes