Skip to content

Commit

Permalink
Add issue templates for bugs and features (#653)
Browse files Browse the repository at this point in the history
  • Loading branch information
urrsk authored Oct 10, 2023
1 parent 2cbb8b2 commit d7af634
Show file tree
Hide file tree
Showing 2 changed files with 164 additions and 0 deletions.
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/new_feature.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: New feature
description: New feature to be suggested
title: "[FEATURE NAME]"
labels: ["enhancement"]

body:
- type: textarea
id: description
attributes:
label: Feature summary
value: |
*Short introduction to the feature and why it should be implemented*
*Followed by a longer description*
### Related issues
*Links to related issues internal or external to this repo*
### Tasks
*To complete this issue involves*
- [ ] Implement the feature
- [ ] Make documentation
- [ ] Make Unit test
- [ ] Make example
- [ ] Test on real hardware
validations:
required: true
136 changes: 136 additions & 0 deletions .github/ISSUE_TEMPLATE/ros_bug.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
name: ROS Issue Report
description: File a ROS related issue report
title: "Issue name"

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report. Before submitting the bug, please first search on the [issue track](../) before creating one.
Please fill out the following as much as possible, to help us reproducing the problem.
Alternatively, if you do not want to share the issue publicly, send a email to [email protected] with the same information.
- type: input
id: ros-driver-version
attributes:
label: Affected ROS Driver version(s)
validations:
required: true

- type: dropdown
id: ros-distribution
attributes:
label: Used ROS distribution.
multiple: true
options:
- Melodic
- Noetic
- Other
validations:
required: true

- type: dropdown
id: ros-platform
attributes:
label: Which combination of platform is the ROS driver running on.
multiple: true
options:
- Linux without realtime patch
- Linux with realtime patch
- Linux in a virtual machine
- Docker
- Windows using WSL2
- Windows
- Linux
- Mac
- Other
validations:
required: true

- type: dropdown
id: ros-driver-install
attributes:
label: How is the UR ROS Driver installed.
options:
- From binary packets
- Build the driver from source and using the UR Client Library from binary
- Build both the ROS driver and UR Client Library from source
validations:
required: true

- type: dropdown
id: robot-platform
attributes:
label: Which robot platform is the driver connected to.
multiple: true
options:
- UR CB3 robot
- UR E-series robot
- Real robot
- URSim in docker
- URSim in a virtual machine
- URSim in linux
validations:
required: true

- type: input
id: robot-sw-version
attributes:
label: Robot SW / URSim version(s)
validations:
required: true

- type: dropdown
id: headless
attributes:
label: How is the ROS driver used.
multiple: true
options:
- Headless without using the teach pendant
- Through the robot teach pendant using External Control URCap
- Others
validations:
required: true

- type: textarea
id: details
attributes:
label: Issue details
description: This part is important in order for us to understand the problem and to clarify the severity of the issue.
value: |
# Summary
*Short introduction to the issue and how it impact you and why*
## Issue details
*Detailed description help us understand the problem. Code are welcome!*
## Steps to Reproduce
*Make simple example to reproduce the issue. Try to remove dependencies to other hardware and software components, if it is possible.*
## Expected Behavior
*What did you expect and why?*
## Actual Behavior
*What did you observe? If possible please attach relevant information.*
# Workaround Suggestion
*If a workaround has been found, you are welcome to share it.*
validations:
required: true

- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell

- type: checkboxes
id: terms
attributes:
label: Accept Public visibility
description: By submitting this issue, you agree to publicly share this information on the github [issue track](../)
options:
- label: I agree to make this context public
required: true

0 comments on commit d7af634

Please sign in to comment.