Skip to content

Commit

Permalink
New , form-based Issue templates for Github repository (#6919)
Browse files Browse the repository at this point in the history
I think a proper issue template based on simple form would make creating
a proper issues easier for users.

These templates can be checked on my fork of this repo:
https://github.com/pktiuk/cvat/issues/new/choose

![image](https://github.com/opencv/cvat/assets/45544416/ffe2a64c-1cc6-4834-8ec9-9548144a21f5)
  • Loading branch information
pktiuk authored Oct 2, 2023
1 parent 4cdd68e commit 78d45fb
Show file tree
Hide file tree
Showing 4 changed files with 107 additions and 44 deletions.
44 changes: 0 additions & 44 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

65 changes: 65 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: "\U0001F41E Bug Report"
description: Create a bug report to help us fix it
labels: ["bug"]
body:
- type: checkboxes
attributes:
label: Actions before raising this issue
options:
- label: I searched the existing issues and did not find anything similar.
required: true
- label: I read/searched [the docs](https://github.com/cvat-ai/cvat/tree/master#documentation)
required: true

- type: textarea
attributes:
label: Steps to Reproduce
description: Provide a link to a live example or an unambiguous set of steps to reproduce this bug. Include code to reproduce, if relevant.
placeholder: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
validations:
required: false
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: false
- type: textarea
attributes:
label: Possible Solution
description: |
Not obligatory, but suggest a fix/reason for the bug, or ideas on how to implement the addition or change
validations:
required: false
- type: textarea
attributes:
label: Context
description: |
How has this issue affected you? What are you trying to accomplish?
Providing context helps us come up with a solution that is most useful in the real world!
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
- type: textarea
attributes:
label: Environment
description: |
Include relevant details about the environment you experienced
placeholder: |
- Git hash commit (`git log -1`):
- Docker version `docker version` (e.g. Docker 17.0.05):
- Are you using Docker Swarm or Kubernetes?
- Operating System and version (e.g. Linux, Windows, MacOS):
- Code example or link to GitHub repo or gist to reproduce problem:
- Other diagnostic information / logs:
<details>
<summary>Logs from `cvat` container</summary>
</details>
render: Markdown
validations:
required: false
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: "\U0001F680 Feature Request"
description: Suggest an idea for this project
labels: ["enhancement"]
body:
- type: checkboxes
attributes:
label: Actions before raising this issue
options:
- label: I searched the existing issues and did not find anything similar.
required: true
- label: I read/searched [the docs](https://github.com/cvat-ai/cvat/tree/master#documentation)
required: true
- type: textarea
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 I have to press this small button.
validations:
required: false
- type: textarea
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
placeholder: Make this button bigger
validations:
required: false
- type: textarea
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
placeholder: I wanted to buy bigger display, but it would be too expensive.
validations:
required: false
- type: textarea
attributes:
label: Additional context
description: |
Add any other context or screenshots about the feature request here.
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Added

- New , form-based Issue templates for Github repository
- TDB

### Changed
Expand Down

0 comments on commit 78d45fb

Please sign in to comment.