-
Notifications
You must be signed in to change notification settings - Fork 430
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
add issue templates. #2667
add issue templates. #2667
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,99 @@ | ||
name: Bug Report | ||
description: File a bug report. | ||
labels: ["bug"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: "**Required Info:**" | ||
- type: checkboxes | ||
attributes: | ||
label: Is there an existing issue for this? | ||
description: Please search to see if an issue already exists for the bug you encountered. | ||
options: | ||
- label: I have searched the existing issues | ||
required: true | ||
- type: textarea | ||
id: regression | ||
attributes: | ||
label: Regression | ||
description: Is the reported bug a regression? If so, what is the last version of ROS where it still worked fine? | ||
- type: input | ||
id: os | ||
attributes: | ||
label: "Operating System:" | ||
description: | | ||
Please try to be specific. | ||
For Linux, please use the command `uname -a` from a terminal and copy paste its output here. | ||
For Windows, open a terminal (Win key + R and type `cmd`), type the command `ver` and press enter. | ||
Then copy paste the output here. | ||
validations: | ||
required: true | ||
- type: input | ||
id: version | ||
attributes: | ||
label: "ROS version or commit hash:" | ||
description: | | ||
**Examples:** *humble*, *iron*, *jazzy*, ... | ||
validations: | ||
required: true | ||
- type: input | ||
id: rmw | ||
attributes: | ||
label: "RMW implementation:" | ||
description: | | ||
**Examples:** *rmw_fastrtps_cpp*, *rmw_connextdds*, *rmw_cyclonedds_cpp*, ... | ||
You can check the ROS Middleware (RMW) implementation with the command: `ros2 doctor --report` | ||
Find the line starting with `middleware name` in the report. | ||
validations: | ||
required: true | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. maybe we can change this into |
||
- type: input | ||
id: clientlib | ||
attributes: | ||
label: "Client library (if applicable):" | ||
description: | | ||
**Examples:** *rclcpp*, *rclpy*, ... | ||
Client libraries are the APIs that allow users to implement their ROS 2 code. | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: doctor | ||
attributes: | ||
label: "'ros2 doctor --report' output" | ||
description: | | ||
It can help us knowing the details of your ROS environment. | ||
Please use the command `ros2 doctor --report` and copy paste its output here. | ||
render: Formatted | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: repro | ||
attributes: | ||
label: "Steps to reproduce issue" | ||
description: | | ||
How do you trigger this bug? Please walk us through it step by step. | ||
Include all the commands you ran in the exact order you ran them so that anyone can reproduce the bug. | ||
placeholder: | | ||
1. | ||
2. | ||
3. | ||
... | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: expected | ||
attributes: | ||
label: "Expected behavior" | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: actual | ||
attributes: | ||
label: "Actual behavior" | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: addinfo | ||
attributes: | ||
label: "Additional information" | ||
validations: | ||
required: false |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
blank_issues_enabled: false | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do we need blank issue template? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. To be organization issue template, i think we can keep blank issue enabled. So that user can use sometimes if the template does not really match against what they are reporting. |
||
contact_links: | ||
- name: Robotics Stack Exchange | ||
url: https://robotics.stackexchange.com/ | ||
about: Please ask and answer questions here. | ||
- name: Documentation for Active ROS Distributions | ||
url: https://docs.ros.org/ | ||
about: Please check our documentation here. | ||
- name: ROS Discourse | ||
url: https://discourse.ros.org/ | ||
about: Discussion on ROS and ROS-related things. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
name: Feature request | ||
description: File a feature request. | ||
labels: ["enhancement"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: "Thanks for taking the time to fill out this feature request form!" | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: Description | ||
description: | | ||
Description in a few sentences what the feature consists of and what problem it will solve. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: motivation | ||
attributes: | ||
label: Motivation | ||
description: | | ||
Description what you are trying to solve, what is the problem to address with this Feature Request. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: implementation | ||
attributes: | ||
label: Design / Implementation Considerations | ||
validations: | ||
required: false | ||
description: | | ||
Relevant information on how the feature could be implemented and pros and cons of the different solutions. | ||
- type: textarea | ||
id: information | ||
attributes: | ||
label: Additional Information | ||
validations: | ||
required: false | ||
description: | | ||
If you have more details information, please describe here. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can probably make it more general field to fill in.