From 6b7331978c5a959e63284b528122f3bf691cbda8 Mon Sep 17 00:00:00 2001 From: Hilary Luo <103377417+hilary-luo@users.noreply.github.com> Date: Wed, 20 Dec 2023 10:43:47 -0500 Subject: [PATCH] Issue forms (#315) * Update issue templates to use form interface and changed assignees * Force issues to be created using the templates * Updating CI package versions * Added new troubleshooting form to differentiate between requests for troubleshooting help and actual bugs * Ask for the impact and motivation of requests to help with prioritization * Rename with numbers to control the order in which they are shown to the user --- .github/ISSUE_TEMPLATE/0-troubleshooting.yml | 124 +++++++++++++++++++ .github/ISSUE_TEMPLATE/1-bug.yml | 111 +++++++++++++++++ .github/ISSUE_TEMPLATE/2-feature.yml | 23 ++++ .github/ISSUE_TEMPLATE/bug.md | 30 ----- .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature.md | 14 --- .github/workflows/ci.yml | 4 +- 7 files changed, 261 insertions(+), 46 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/0-troubleshooting.yml create mode 100644 .github/ISSUE_TEMPLATE/1-bug.yml create mode 100644 .github/ISSUE_TEMPLATE/2-feature.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature.md diff --git a/.github/ISSUE_TEMPLATE/0-troubleshooting.yml b/.github/ISSUE_TEMPLATE/0-troubleshooting.yml new file mode 100644 index 0000000..26d0c63 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/0-troubleshooting.yml @@ -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. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/1-bug.yml b/.github/ISSUE_TEMPLATE/1-bug.yml new file mode 100644 index 0000000..e1d2ea5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-bug.yml @@ -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. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/2-feature.yml b/.github/ISSUE_TEMPLATE/2-feature.yml new file mode 100644 index 0000000..1bf7583 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-feature.yml @@ -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. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md deleted file mode 100644 index 1ac6e91..0000000 --- a/.github/ISSUE_TEMPLATE/bug.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -name: Bug Report -about: Provide a report for what the issue is -title: '' -labels: bug -assignees: hilary-luo - ---- - -**Please provide the following information:** - - OS: (e.g. Ubuntu 20.04) - - ROS Distro: (e.g. Galactic) - - Built from source or installed: - - Package version: (if from repository, give version from `sudo dpkg -s ros-$ROS_VERSION-turtlebot4-PACKAGE_WITH_ISSUE`, if from source, give commit hash) - - **Expected behaviour** - A clear and concise description of what you expected to happen. - - **Actual behaviour** - A clear and concise description of what you encountered. - -**To Reproduce** -Provide the steps to reproduce: -1. run something -2. launch something else -3. see the error - - -**Other notes** -Add anything else you thing is important. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..ec4bb38 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md deleted file mode 100644 index 2e3a5ba..0000000 --- a/.github/ISSUE_TEMPLATE/feature.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -name: Feature request -about: Provide context for the feature you are requesting -title: '' -labels: enhancement -assignees: hilary-luo - ---- - -**Describe the the feature you would like** -A clear and concise description of what you want to happen. - -**Other notes** -Add anything else you thing is important. \ No newline at end of file diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index c153c4a..2e39ee0 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -8,10 +8,10 @@ jobs: runs-on: ubuntu-22.04 steps: - uses: actions/checkout@v2.3.4 - - 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