Skip to content

Commit

Permalink
Add templates
Browse files Browse the repository at this point in the history
Signed-off-by: Peter Borkuti <[email protected]>
  • Loading branch information
peterborkuti authored and Peter Borkuti committed May 28, 2024
1 parent eea42eb commit 62a683c
Show file tree
Hide file tree
Showing 3 changed files with 115 additions and 0 deletions.
84 changes: 84 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
name: Bug Report
description: File a bug report.
title: "[Bug]: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: "**Required Info:**"
- 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: dds
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
- 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 it's output here.
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."
value: |
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
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: false
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: Talk about ROS and ROS related things.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Feature request
description: File a feature request.
title: "[Feature]: "
labels: ["feature"]
body:
- type: markdown
attributes:
value: "Thanks for taking the time to fill out this feature request form!"
- type: textarea
id: description
attributes:
label: Feature description
validations:
required: true
- type: textarea
id: implementation
attributes:
label: Implementation considerations
validations:
required: false

0 comments on commit 62a683c

Please sign in to comment.