Skip to content

Commit

Permalink
chore: add templates for pull requests and issues (#2)
Browse files Browse the repository at this point in the history
Signed-off-by: mitsudome-r <[email protected]>
  • Loading branch information
mitsudome-r authored Feb 9, 2024
1 parent 46c7199 commit bd786f4
Show file tree
Hide file tree
Showing 4 changed files with 126 additions and 0 deletions.
71 changes: 71 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
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.
options:
- label: I've read the [contribution guidelines](https://github.com/autowarefoundation/autoware/blob/main/CONTRIBUTING.md).
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:
- Autoware:
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
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
blank_issues_enabled: false
contact_links:
- name: Question
url: https://github.com/autowarefoundation/autoware/discussions/new?category=q-a
about: Ask a question

- name: Feature request
url: https://github.com/autowarefoundation/autoware/discussions/new?category=feature-requests
about: Send a feature request

- name: Idea
url: https://github.com/autowarefoundation/autoware/discussions/new?category=ideas
about: Post an idea
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/task.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
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.
options:
- label: I've read the [contribution guidelines](https://github.com/autowarefoundation/autoware/blob/main/CONTRIBUTING.md).
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
File renamed without changes.

0 comments on commit bd786f4

Please sign in to comment.