Skip to content

Commit 2699593

Browse files
authored
Use yaml for issue templates + revamp (#5116)
* Convert issue templates to yaml * Revamp issue templates * Minor improvements * Minor change * Fix link * Address review comment * Revert + update link
1 parent 462ba9a commit 2699593

File tree

7 files changed

+111
-80
lines changed

7 files changed

+111
-80
lines changed

.github/ISSUE_TEMPLATE/add-dataset.md

Lines changed: 0 additions & 17 deletions
This file was deleted.
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Add dataset
2+
description: Request the addition of a specific dataset to the Hub
3+
labels: ["dataset request"]
4+
body:
5+
- type: input
6+
id: name
7+
attributes:
8+
label: Name
9+
description: Name of the dataset
10+
validations:
11+
required: true
12+
13+
- type: input
14+
id: paper
15+
attributes:
16+
label: Paper
17+
description: Link to the dataset paper if available
18+
19+
- type: input
20+
id: data
21+
attributes:
22+
label: Data
23+
description: Link to the Github repository or current dataset location
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
id: motivation
29+
attributes:
30+
label: Motivation
31+
description: What are some good reasons to have this dataset
32+
validations:
33+
required: true
34+
35+
- type: markdown
36+
attributes:
37+
value: Instructions to add a new dataset can be found [here](https://huggingface.co/docs/datasets/share).

.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 0 additions & 29 deletions
This file was deleted.
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Bug report
2+
description: Create a report to help reproduce and fix the bug
3+
body:
4+
- type: textarea
5+
id: description
6+
attributes:
7+
label: Describe the bug
8+
description: A clear and concise description of what the bug is
9+
validations:
10+
required: true
11+
12+
- type: textarea
13+
id: reproduction
14+
attributes:
15+
label: Steps to reproduce the bug
16+
description: |
17+
Please provide a code sample that reproduces the problem you ran into. It can be a Colab link or just a code snippet.
18+
If you have code snippets, error messages, stack traces please provide them here as well.
19+
Important! Use code tags to correctly format your code. See https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting
20+
Do not use screenshots, as they are hard to read and (more importantly) don't allow others to copy-and-paste your code.
21+
placeholder: |
22+
Steps to reproduce the behavior:
23+
24+
1.
25+
2.
26+
3.
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
id: expected-behavior
32+
validations:
33+
required: true
34+
attributes:
35+
label: Expected behavior
36+
description: A clear and concise description of the expected results.
37+
38+
- type: textarea
39+
id: environment-info
40+
attributes:
41+
label: Environment info
42+
description: Please share your environemnt info with us. You can run the command `datasets-cli env` and copy-paste its output below.
43+
placeholder: datasets version, platform, python version, ...
44+
validations:
45+
required: true

.github/ISSUE_TEMPLATE/feature-request.md

Lines changed: 0 additions & 20 deletions
This file was deleted.
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Feature request
2+
description: Suggest an idea for this project
3+
labels: ["enhancement"]
4+
body:
5+
- type: textarea
6+
id: feature-request
7+
attributes:
8+
label: Feature request
9+
description: A clear and concise description of the feature proposal.
10+
validations:
11+
required: true
12+
13+
- type: textarea
14+
id: motivation
15+
validations:
16+
required: true
17+
attributes:
18+
label: Motivation
19+
description: |
20+
Please outline the motivation for the proposal. Is your feature request related to a problem? e.g., I'm always frustrated when [...]. If this is related to another GitHub issue, please link here too.
21+
22+
- type: textarea
23+
id: contribution
24+
validations:
25+
required: true
26+
attributes:
27+
label: Your contribution
28+
description: |
29+
Is there any way that you could help, e.g. by submitting a PR? Make sure to read the CONTRIBUTING.MD [readme](https://github.com/huggingface/datasets/blob/main/CONTRIBUTING.md).

.github/PULL_REQUEST_TEMPLATE/add_dataset.md

Lines changed: 0 additions & 14 deletions
This file was deleted.

0 commit comments

Comments
 (0)