diff --git a/.github/ISSUE_TEMPLATE/1-add_documentation_report.yml b/.github/ISSUE_TEMPLATE/1-add_documentation_report.yml new file mode 100644 index 0000000000..6ca07d7997 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-add_documentation_report.yml @@ -0,0 +1,26 @@ +name: "\U0001F4DA Add a documentation report" +description: "Have you spotted a typo or mistake in our docs?" +title: "[DOCS]" +labels: ["documentation"] +assignees: [] + +body: + - type: markdown + attributes: + value: "Thank you for reporting a documentation mistake! Before you get started, please [search to see](https://github.com/argilla-io/distilabel/issues) if an issue already exists for the bug you encountered." + + - type: textarea + id: doc_report + attributes: + label: "Which page or section is this issue related to?" + description: "Please include the URL and/or source." + validations: + required: false + + - type: textarea + id: doc_review + attributes: + label: "What are you documenting, or what change are you making in the documentation?" + description: "If a documentation needs to be created, please specify its coverage.\n If there's a typo or something needs revisiting, please indicate it and show code/text/screenshots." + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/2-bug_python.yml b/.github/ISSUE_TEMPLATE/2-bug_python.yml new file mode 100644 index 0000000000..b4733ebecd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-bug_python.yml @@ -0,0 +1,70 @@ +name: "\U0001FAB2 Bug report" +description: "Report bugs and unexpected behavior." +title: "[BUG]" +labels: ["bug", "ml-internal"] +assignees: [] + +body: + - type: markdown + attributes: + value: "Thank you for reporting a bug! Before you get started, please [search to see](https://github.com/argilla-io/distilabel/issues) if an issue already exists for the bug you encountered." + + - type: textarea + id: bug_description + attributes: + label: "Describe the bug" + description: "A clear and concise description of the bug." + validations: + required: true + + - type: textarea + id: stacktrace + attributes: + label: "To reproduce" + description: "The code to reproduce the behavior." + placeholder: | + ```python + my_python_code + ``` + validations: + required: false + + - type: textarea + id: expected_behavior + attributes: + label: "Expected behavior" + description: "A clear and concise description of what you expected to happen." + validations: + required: false + + - type: textarea + id: screenshots + attributes: + label: "Screenshots" + description: "If applicable, add screenshots to help explain your problem." + validations: + required: false + + - type: textarea + id: environment + attributes: + label: "Environment" + description: "Since version 1.16.0 you can use `python -m argilla info` command to easily get the used versions." + value: | + - Distilabel Version [e.g. 1.0.0]: + - Python Version [e.g. 3.11]: + validations: + required: false + + - type: textarea + id: additional_context + attributes: + label: "Additional context" + description: "Add any other relevant information." + validations: + required: false + + - type: markdown + attributes: + value: | + 📌 Make sure you have provided all the required information in each section so we can support you properly. diff --git a/.github/ISSUE_TEMPLATE/3-feature_request.yml b/.github/ISSUE_TEMPLATE/3-feature_request.yml new file mode 100644 index 0000000000..6572e2a457 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-feature_request.yml @@ -0,0 +1,44 @@ +name: "\U0001F195 Feature request" +description: "Share cool new ideas for the project." +title: "[FEATURE]" +labels: ["enhancement", "ml-internal"] +assignees: [] + + +body: + - type: markdown + attributes: + value: "Thank you for sharing your feature request! Please fill out the sections below." + + - type: textarea + id: feature_request + attributes: + label: "Is your feature request related to a problem? Please describe." + description: "A clear and concise description of what the problem is." + placeholder: "I'm always frustrated when..." + validations: + required: false + + - type: textarea + id: feature_description + attributes: + label: "Describe the solution you'd like" + description: "A clear and concise description of what you want to happen." + validations: + required: false + + - type: textarea + id: feature_alternatives + attributes: + label: "Describe alternatives you've considered" + description: "A clear and concise description of any alternative solutions or features you've considered." + validations: + required: false + + - type: textarea + id: additional_context + attributes: + label: "Additional context" + description: "Add any other context or screenshots about the feature request here." + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/blank-issue-template.md b/.github/ISSUE_TEMPLATE/4-blank-issue-template.md similarity index 100% rename from .github/ISSUE_TEMPLATE/blank-issue-template.md rename to .github/ISSUE_TEMPLATE/4-blank-issue-template.md diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..a9944106c4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: 🗯 Community Discussions + url: http://hf.co/join/discord + about: Our Discord Community loves to discuss distilabel and NLP topics diff --git "a/.github/ISSUE_TEMPLATE/\360\237\206\225-feature-request.md" "b/.github/ISSUE_TEMPLATE/\360\237\206\225-feature-request.md" deleted file mode 100644 index 2bd974da3a..0000000000 --- "a/.github/ISSUE_TEMPLATE/\360\237\206\225-feature-request.md" +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: "\U0001F195 Feature request" -about: Suggest an idea for this project. -title: "[FEATURE]" -labels: enhancement, ml-internal -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git "a/.github/ISSUE_TEMPLATE/\360\237\220\233-bug-report.md" "b/.github/ISSUE_TEMPLATE/\360\237\220\233-bug-report.md" deleted file mode 100644 index ae2c21cf68..0000000000 --- "a/.github/ISSUE_TEMPLATE/\360\237\220\233-bug-report.md" +++ /dev/null @@ -1,30 +0,0 @@ ---- -name: "\U0001F41B Bug report" -about: Create a report to help us improve. -title: "[BUG]" -labels: bug, ml-internal -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Code to reproduce -```python - -``` - -**Expected behaviour** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - Package version: - - Python version: - -**Additional context** -Add any other context about the problem here. diff --git "a/.github/ISSUE_TEMPLATE/\360\237\223\232-documentation-update.md" "b/.github/ISSUE_TEMPLATE/\360\237\223\232-documentation-update.md" deleted file mode 100644 index 01e8234da5..0000000000 --- "a/.github/ISSUE_TEMPLATE/\360\237\223\232-documentation-update.md" +++ /dev/null @@ -1,16 +0,0 @@ ---- -name: "\U0001F4D9 Documentation update" -about: Create a piece of documentation or update one that needs some care. -title: "[DOCS]" -labels: documentation -assignees: "" ---- - -## Which page or section is this issue related to? - - - -## What are you documenting, or what change are you making in the documentation? - - -