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

Issue forms #315

Merged
merged 8 commits into from
Dec 20, 2023
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
124 changes: 124 additions & 0 deletions .github/ISSUE_TEMPLATE/0-troubleshooting.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
name: Troubleshooting Help
description: Use this form when you are looking for assistance to understand why the system is not working how you think it should.
labels: ["troubleshooting"]
assignees:
- smatar22
- RustyCPR
body:
- type: markdown
attributes:
value: "# System Information"
- type: dropdown
id: model
attributes:
label: Robot Model
description: Standard has a screen, Lite does not. For simulation select the one that you are simulating.
options:
- Select One
- Turtlebot4 Standard
- Turtlebot4 Lite
validations:
required: true
- type: dropdown
id: ros-distro
attributes:
label: ROS distro
description: What ROS distribution are you using (must match on all devices in the system)?
options:
- Select One
- Galactic
- Humble
validations:
required: true
- type: dropdown
id: networking
attributes:
label: Networking Configuration
options:
- Select One
- Simple Discovery
- Discovery Server
- I do not know
validations:
required: true
- type: dropdown
id: os
attributes:
label: OS
description: What OS are you running on your companion PC (used to interact with the Turtlebot4)?
options:
- Select One
- Ubuntu 20.04
- Ubuntu 22.04
- Other Linux
- Windows / MAC
validations:
required: true
- type: dropdown
id: build-type
attributes:
label: Built from source or installed?
description: Did you build from source (build the packages yourself) or did you install the packages (e.g. `sudo apt install ...`)?
options:
- Select One
- Built from Source
- Installed
validations:
required: true
- type: textarea
id: version
attributes:
label: Package version
description: What version of the package are you running? (if installed run `dpkg -s ros-$ROS_DISTRO-turtlebot4-PACKAGE_WITH_ISSUE`, if from source, give commit hash)
validations:
required: true

- type: markdown
attributes:
value: "# Problem Description"
- type: dropdown
id: topic-tag
attributes:
label: Type of issue
description: What component or topic do you need help with?
options:
- Select One
- Networking
- Camera
- LIDAR
- Battery
- Navigation (SLAM, Nav2 etc.)
- Other
validations:
required: true
- type: textarea
attributes:
label: Expected behaviour
description: A clear and concise description of what you expected to happen.
validations:
required: true
- type: textarea
attributes:
label: Actual behaviour
description: A clear and concise description of what you encountered.
validations:
required: true
- type: textarea
attributes:
label: Error messages
description: Error messages copied from terminal and/or relevant logs. Copy these directly from the terminal in full.
render: bash
- type: textarea
attributes:
label: To Reproduce
description: Provide the steps to reproduce.
placeholder: |
1. run something
2. launch something else
3. see the error
validations:
required: true
- type: textarea
attributes:
label: Other notes
description: Add anything else you thing is important.
111 changes: 111 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
name: Bug Report
description: Use this form when you are confident that there is a bug in this particular package. If you are not sure then use the Troubleshooting Form.
labels: ["bug"]
assignees:
- hilary-luo
body:
- type: markdown
attributes:
value: __Only use this form if you are confident that there is a bug in this package and that it is not user error. If you are not sure then please use the troubleshooting form.__
- type: markdown
attributes:
value: "# System Information"
- type: dropdown
id: model
attributes:
label: Robot Model
description: Standard has a screen, Lite does not. For simulation select the one that you are simulating.
options:
- Select One
- Turtlebot4 Standard
- Turtlebot4 Lite
validations:
required: true
- type: dropdown
id: ros-distro
attributes:
label: ROS distro
description: What ROS distribution are you using (must match on all devices in the system)?
options:
- Select One
- Galactic
- Humble
validations:
required: true
- type: dropdown
id: networking
attributes:
label: Networking Configuration
options:
- Select One
- Simple Discovery
- Discovery Server
- I do not know
validations:
required: true
- type: dropdown
id: os
attributes:
label: OS
description: What OS are you running on your companion PC (used to interact with the Turtlebot4)?
options:
- Select One
- Ubuntu 20.04
- Ubuntu 22.04
- Other Linux
- Windows / MAC
validations:
required: true
- type: dropdown
id: build-type
attributes:
label: Built from source or installed?
description: Did you build from source (build the packages yourself) or did you install the packages (e.g. `sudo apt install ...`)?
options:
- Select One
- Built from Source
- Installed
validations:
required: true
- type: textarea
id: version
attributes:
label: Package version
description: What version of the package are you running? (if installed run `dpkg -s ros-$ROS_DISTRO-turtlebot4-PACKAGE_WITH_ISSUE`, if from source, give commit hash)
validations:
required: true

- type: markdown
attributes:
value: "# Problem Description"
- type: textarea
attributes:
label: Expected behaviour
description: A clear and concise description of what you expected to happen.
validations:
required: true
- type: textarea
attributes:
label: Actual behaviour
description: A clear and concise description of what you encountered.
validations:
required: true
- type: textarea
attributes:
label: Error messages
description: Error messages copied from terminal and/or relevant logs. Copy these directly from the terminal in full.
render: bash
- type: textarea
attributes:
label: To Reproduce
description: Provide the steps to reproduce.
placeholder: |
1. run something
2. launch something else
3. see the error
validations:
required: true
- type: textarea
attributes:
label: Other notes
description: Add anything else you thing is important.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Feature request
description: Use this form for requesting a feature that current doesn't exist.
labels: ["enhancement"]
assignees:
- smatar22
- RustyCPR
body:
- type: textarea
attributes:
label: Describe the the feature you would like
description: A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
attributes:
label: Motivation and impact
description: Why is this an important feature and who will it impact?
validations:
required: true
- type: textarea
attributes:
label: Other notes
description: Add anything else you thing is important.
30 changes: 0 additions & 30 deletions .github/ISSUE_TEMPLATE/bug.md

This file was deleted.

1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
14 changes: 0 additions & 14 deletions .github/ISSUE_TEMPLATE/feature.md

This file was deleted.

4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ jobs:
runs-on: ubuntu-22.04
steps:
- uses: actions/[email protected]
- uses: ros-tooling/setup-ros@v0.3
- uses: ros-tooling/setup-ros@v0.7
with:
required-ros-distributions: humble
- uses: ros-tooling/action-ros-ci@v0.2
- uses: ros-tooling/action-ros-ci@v0.3
id: action_ros_ci_step
with:
target-ros2-distro: humble
Expand Down
Loading