Skip to content

Commit 7733ad5

Browse files
authored
[Docs] configure issue form (#5703)
# Description <!-- Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change. --> Just saw this in Notion and took the opportunity to do so when reviewing the docs. Closes #<issue_number> **Type of change** <!-- Please delete options that are not relevant. Remember to title the PR according to the type of change --> - Bug fix (non-breaking change which fixes an issue) - New feature (non-breaking change which adds functionality) - Breaking change (fix or feature that would cause existing functionality to not work as expected) - Refactor (change restructuring the codebase without changing functionality) - Improvement (change adding some improvement to an existing functionality) - Documentation update **How Has This Been Tested** <!-- Please add some reference about how your feature has been tested. --> **Checklist** <!-- Please go over the list and make sure you've taken everything into account --> - I added relevant documentation - I followed the style guidelines of this project - I did a self-review of my code - I made corresponding changes to the documentation - I confirm My changes generate no new warnings - I have added tests that prove my fix is effective or that my feature works - I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/)
1 parent 56864b8 commit 7733ad5

File tree

8 files changed

+202
-97
lines changed

8 files changed

+202
-97
lines changed
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: "\U0001F4DA Add a documentation report"
2+
description: "Have you spotted a typo or mistake in our docs?"
3+
title: "[DOCS]"
4+
labels: []
5+
assignees: []
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: "Thank you for reporting a documentation mistake! Before you get started, please [search to see](https://github.com/argilla-io/argilla/issues) if an issue already exists for the bug you encountered."
11+
12+
- type: textarea
13+
id: doc_report
14+
attributes:
15+
label: "Which page or section is this issue related to?"
16+
description: "Please include the URL and/or source."
17+
validations:
18+
required: false
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
name: "\U0001FAB2 Bug report: Python/Deployment"
2+
description: "Report Python or Deployment bugs and unexpected behavior."
3+
title: "[BUG-python/deployment]"
4+
labels: []
5+
assignees: []
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: "Thank you for reporting a bug! Before you get started, please [search to see](https://github.com/argilla-io/argilla/issues) if an issue already exists for the bug you encountered."
11+
12+
- type: textarea
13+
id: bug_description
14+
attributes:
15+
label: "Describe the bug"
16+
description: "A clear and concise description of the bug."
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: stacktrace
22+
attributes:
23+
label: "Stacktrace and code to create the bug"
24+
description: "The code to reproduce the behavior."
25+
placeholder: |
26+
```python
27+
my_python_code
28+
```
29+
```bash
30+
my_bash_code
31+
```
32+
validations:
33+
required: false
34+
35+
- type: textarea
36+
id: expected_behavior
37+
attributes:
38+
label: "Expected behavior"
39+
description: "A clear and concise description of what you expected to happen."
40+
validations:
41+
required: false
42+
43+
- type: textarea
44+
id: environment
45+
attributes:
46+
label: "Environment"
47+
description: "Since version 1.16.0 you can use `python -m argilla info` command to easily get the used versions."
48+
value: |
49+
- Argilla Version [e.g. 1.0.0]:
50+
- ElasticSearch Version [e.g. 7.10.2]:
51+
- Docker Image (optional) [e.g. argilla:v1.0.0]:
52+
validations:
53+
required: false
54+
55+
- type: textarea
56+
id: additional_context
57+
attributes:
58+
label: "Additional context"
59+
description: "Add any other relevant information."
60+
validations:
61+
required: false
62+
63+
- type: markdown
64+
attributes:
65+
value: |
66+
📌 Make sure you have provided all the required information in each section so we can support you properly.
Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
name: "\U0001F41E Bug report: UI/UX"
2+
description: "Report UI or UX bugs and unexpected behavior."
3+
title: "[BUG-UI/UX]"
4+
labels: []
5+
assignees: []
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: "Thank you for reporting a UI/UX bug! Before you get started, please [search to see](https://github.com/argilla-io/argilla/issues) if an issue already exists for the bug you encountered."
11+
12+
- type: textarea
13+
id: bug_description
14+
attributes:
15+
label: "Describe the bug"
16+
description: "A clear and concise description of the bug."
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: to_reproduce
22+
attributes:
23+
label: "To reproduce"
24+
description: "The steps to reproduce the behavior."
25+
placeholder: |
26+
1. Go to '...'
27+
2. Click on '....'
28+
3. Scroll down to '....'
29+
4. See error
30+
validations:
31+
required: false
32+
33+
- type: textarea
34+
id: expected_behavior
35+
attributes:
36+
label: "Expected behavior"
37+
description: "A clear and concise description of what you expected to happen."
38+
validations:
39+
required: false
40+
41+
- type: textarea
42+
id: screenshots
43+
attributes:
44+
label: "Screenshots"
45+
description: "If applicable, add screenshots to help explain your problem."
46+
validations:
47+
required: false
48+
49+
- type: textarea
50+
id: environment
51+
attributes:
52+
label: "Environment"
53+
description: "Since version 1.16.0 you can use `python -m argilla info` command to easily get the used versions."
54+
value: |
55+
- OS [e.g. iOS]:
56+
- Browser [e.g. chrome, safari]:
57+
- Argilla Version [e.g. 1.0.0]:
58+
- ElasticSearch Version [e.g. 7.10.2]:
59+
- Docker Image (optional) [e.g. argilla:v1.0.0]:
60+
validations:
61+
required: false
62+
63+
- type: textarea
64+
id: additional_context
65+
attributes:
66+
label: "Additional context"
67+
description: "Add any other relevant information."
68+
validations:
69+
required: false
70+
71+
- type: markdown
72+
attributes:
73+
value: |
74+
📌 Make sure you have provided all the required information in each section so we can support you properly.
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: "\U0001F195 Feature request"
2+
description: "Share cool new ideas for the project."
3+
title: "[FEATURE]"
4+
labels: []
5+
assignees: []
6+
7+
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: "Thank you for sharing your feature request! Please fill out the sections below."
12+
13+
- type: textarea
14+
id: feature_request
15+
attributes:
16+
label: "Is your feature request related to a problem? Please describe."
17+
description: "A clear and concise description of what the problem is."
18+
placeholder: "I'm always frustrated when..."
19+
validations:
20+
required: false
21+
22+
- type: textarea
23+
id: feature_description
24+
attributes:
25+
label: "Describe the solution you'd like"
26+
description: "A clear and concise description of what you want to happen."
27+
validations:
28+
required: false
29+
30+
- type: textarea
31+
id: feature_alternatives
32+
attributes:
33+
label: "Describe alternatives you've considered"
34+
description: "A clear and concise description of any alternative solutions or features you've considered."
35+
validations:
36+
required: false
37+
38+
- type: textarea
39+
id: additional_context
40+
attributes:
41+
label: "Additional context"
42+
description: "Add any other context or screenshots about the feature request here."
43+
validations:
44+
required: false

.github/ISSUE_TEMPLATE/🆕-feature-request.md

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

.github/ISSUE_TEMPLATE/🐞-bug-ui-ux.md

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

.github/ISSUE_TEMPLATE/📚-add-a-documentation-report.md

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

.github/ISSUE_TEMPLATE/🪲-bug-python-deployment.md

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

0 commit comments

Comments
 (0)