Skip to content

Commit

Permalink
[Docs] configure issue form (#5703)
Browse files Browse the repository at this point in the history
# 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/)
  • Loading branch information
sdiazlor authored Nov 27, 2024
1 parent 56864b8 commit 7733ad5
Show file tree
Hide file tree
Showing 8 changed files with 202 additions and 97 deletions.
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/add_documentation_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: "\U0001F4DA Add a documentation report"
description: "Have you spotted a typo or mistake in our docs?"
title: "[DOCS]"
labels: []
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/argilla/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
66 changes: 66 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_python_deployment.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
name: "\U0001FAB2 Bug report: Python/Deployment"
description: "Report Python or Deployment bugs and unexpected behavior."
title: "[BUG-python/deployment]"
labels: []
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/argilla/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: "Stacktrace and code to create the bug"
description: "The code to reproduce the behavior."
placeholder: |
```python
my_python_code
```
```bash
my_bash_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: 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: |
- Argilla Version [e.g. 1.0.0]:
- ElasticSearch Version [e.g. 7.10.2]:
- Docker Image (optional) [e.g. argilla:v1.0.0]:
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.
74 changes: 74 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_ui_ux.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
name: "\U0001F41E Bug report: UI/UX"
description: "Report UI or UX bugs and unexpected behavior."
title: "[BUG-UI/UX]"
labels: []
assignees: []

body:
- type: markdown
attributes:
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."

- 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: to_reproduce
attributes:
label: "To reproduce"
description: "The steps to reproduce the behavior."
placeholder: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
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: |
- OS [e.g. iOS]:
- Browser [e.g. chrome, safari]:
- Argilla Version [e.g. 1.0.0]:
- ElasticSearch Version [e.g. 7.10.2]:
- Docker Image (optional) [e.g. argilla:v1.0.0]:
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.
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
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: []
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
19 changes: 0 additions & 19 deletions .github/ISSUE_TEMPLATE/🆕-feature-request.md

This file was deleted.

36 changes: 0 additions & 36 deletions .github/ISSUE_TEMPLATE/🐞-bug-ui-ux.md

This file was deleted.

10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/📚-add-a-documentation-report.md

This file was deleted.

32 changes: 0 additions & 32 deletions .github/ISSUE_TEMPLATE/🪲-bug-python-deployment.md

This file was deleted.

0 comments on commit 7733ad5

Please sign in to comment.