-
Notifications
You must be signed in to change notification settings - Fork 144
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update issue templates (#1074)
- Loading branch information
Showing
8 changed files
with
145 additions
and
66 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.