Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add bug and task issue templates #42

Merged
merged 2 commits into from
Jun 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: Bug
description: Report a bug
body:

- type: checkboxes
attributes:
label: Checklist
description: Confirm the following items before proceeding. If one cannot be satisfied, create a discussion thread instead.
required: true - label: I've searched other issues and no duplicate issues were found.
required: true - label: I'm convinced that this is not my fault but a bug.
required: true

- type: textarea
attributes:
label: Description
description: Write a brief description of the bug.
validations:
required: true

- type: textarea
attributes:
label: Expected behavior
description: Describe the expected behavior.
validations:
required: true

- type: textarea
attributes:
label: Actual behavior
description: Describe the actual behavior.
validations:
required: true

- type: textarea
attributes:
label: Steps to reproduce
description: Write the steps to reproduce the bug.
placeholder: |- 1. 2. 3.
validations:
required: true

- type: textarea
attributes:
label: Versions
description: Provide the version information. You can omit this if you believe it's irrelevant.
placeholder: |- - OS: - ROS 2:
validations:
required: false

- type: textarea
attributes:
label: Possible causes
description: Write the possible causes if you have any ideas.
validations:
required: false

- type: textarea
attributes:
label: Additional context
description: Add any other additional context if it exists.
validations:
required: false
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/task.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Task
description: Plan a task
body:

- type: checkboxes
attributes:
label: Checklist
description: Confirm the following items before proceeding. If one cannot be satisfied, create a discussion thread instead.
required: true - label: I've searched other issues and no duplicate issues were found.
required: true - label: I've agreed with the maintainers that I can plan this task.
required: true

- type: textarea
attributes:
label: Description
description: Write a brief description of the task.
validations:
required: true

- type: textarea
attributes:
label: Purpose
description: Describe the purpose of the task.
validations:
required: true

- type: textarea
attributes:
label: Possible approaches
description: Describe possible approaches for the task.
validations:
required: true

- type: textarea
attributes:
label: Definition of done
description: Write the definition of done for the task.
validations:
required: true
Loading