From 36b4221a67cc53b359352d3d3c9b5ec534a2d31d Mon Sep 17 00:00:00 2001 From: Peter Borkuti Date: Fri, 24 May 2024 19:52:52 +0200 Subject: [PATCH 01/11] Add templates Signed-off-by: Peter Borkuti --- .github/ISSUE_TEMPLATE/bug_report.yml | 85 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 11 +++ .github/ISSUE_TEMPLATE/feature_request.yml | 20 +++++ 3 files changed, 116 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..096d578ad --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,85 @@ +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. + 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." + 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 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..f7ea528e4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..b2d0ecd30 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -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 From 2800da8deac482d88a5f3dc001c3097dc574872a Mon Sep 17 00:00:00 2001 From: Peter Borkuti Date: Tue, 11 Jun 2024 18:23:43 +0200 Subject: [PATCH 02/11] Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: Audrow Nash Signed-off-by: Peter Borkuti --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 096d578ad..677916117 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -12,7 +12,7 @@ body: 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 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 From 11665451fdbc067da104a6eaae6c2dad0f9b1c64 Mon Sep 17 00:00:00 2001 From: Peter Borkuti Date: Tue, 11 Jun 2024 18:23:56 +0200 Subject: [PATCH 03/11] Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: Audrow Nash Signed-off-by: Peter Borkuti --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 677916117..6d769d951 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -13,7 +13,7 @@ body: 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. + 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 From 8d65cbef051378cfd30fd56b0a00a424eae4c42a Mon Sep 17 00:00:00 2001 From: Peter Borkuti Date: Tue, 11 Jun 2024 18:24:06 +0200 Subject: [PATCH 04/11] Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: Christophe Bedard Signed-off-by: Peter Borkuti --- .github/ISSUE_TEMPLATE/bug_report.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 6d769d951..bd9a19b24 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -57,7 +57,9 @@ body: id: repro attributes: label: "Steps to reproduce issue" - description: "How do you trigger this bug? Please walk us through it step by step." + 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. From ba8fc7ee09db17d19a08fdda07396988a693bb04 Mon Sep 17 00:00:00 2001 From: Peter Borkuti Date: Tue, 11 Jun 2024 18:25:10 +0200 Subject: [PATCH 05/11] Update .github/ISSUE_TEMPLATE/config.yml Co-authored-by: Audrow Nash Signed-off-by: Peter Borkuti --- .github/ISSUE_TEMPLATE/config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index f7ea528e4..d8d1c5f54 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -8,4 +8,4 @@ contact_links: about: Please check our documentation here. - name: ROS Discourse url: https://discourse.ros.org/ - about: Talk about ROS and ROS related things. + about: Talk about ROS and ROS-related things. From ac947de0637a4b1f98ecea18f1ee1bd0c8428afd Mon Sep 17 00:00:00 2001 From: Peter Borkuti Date: Tue, 11 Jun 2024 18:26:09 +0200 Subject: [PATCH 06/11] Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: Christophe Bedard Signed-off-by: Peter Borkuti --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index bd9a19b24..21b6d12b2 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -49,7 +49,7 @@ body: 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. + Please use the command `ros2 doctor --report` and copy paste its output here. render: Formatted validations: required: false From 585d0955dbc8c7af734fecd64813618648d88909 Mon Sep 17 00:00:00 2001 From: Peter Borkuti Date: Tue, 11 Jun 2024 18:31:29 +0200 Subject: [PATCH 07/11] remove [bug] from title Signed-off-by: Peter Borkuti --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 21b6d12b2..215b7d78c 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,6 +1,6 @@ name: Bug Report description: File a bug report. -title: "[Bug]: " +title: "" labels: ["bug"] body: - type: markdown From f471e6f91e0e34e845836bfa98a503fb8369f3d0 Mon Sep 17 00:00:00 2001 From: Peter Borkuti Date: Tue, 11 Jun 2024 18:32:21 +0200 Subject: [PATCH 08/11] Update bug_report.yml Signed-off-by: Peter Borkuti --- .github/ISSUE_TEMPLATE/bug_report.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 215b7d78c..c496e1c74 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,6 +1,5 @@ name: Bug Report description: File a bug report. -title: "" labels: ["bug"] body: - type: markdown From ac4022d3f3181c4b446b16ffb2976c5ac810c9d1 Mon Sep 17 00:00:00 2001 From: Peter Borkuti Date: Tue, 11 Jun 2024 18:35:05 +0200 Subject: [PATCH 09/11] remove title Signed-off-by: Peter Borkuti --- .github/ISSUE_TEMPLATE/feature_request.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index b2d0ecd30..a2c65ce60 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,6 +1,5 @@ name: Feature request description: File a feature request. -title: "[Feature]: " labels: ["feature"] body: - type: markdown From f4f64d32f81f34c58dae42dc8920081dbdcc7990 Mon Sep 17 00:00:00 2001 From: Peter Borkuti Date: Mon, 17 Jun 2024 21:42:29 +0200 Subject: [PATCH 10/11] remove old template Signed-off-by: Peter Borkuti --- .github/ISSUE_TEMPLATE.md | 45 --------------------------------------- 1 file changed, 45 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index f705392bb..000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,45 +0,0 @@ - - -## Bug report - -**Required Info:** - -- Operating System: - - -- Installation type: - - -- Version or commit hash: - - -- DDS implementation: - - -- Client library (if applicable): - - - -#### Steps to reproduce issue - -``` - -``` - -#### Expected behavior - -#### Actual behavior - -#### Additional information - - ----- -## Feature request - -#### Feature description - - -#### Implementation considerations - From ff397ff1c6a66583faa141c5af89ee3381c52e08 Mon Sep 17 00:00:00 2001 From: Peter Borkuti Date: Wed, 30 Oct 2024 19:52:20 +0100 Subject: [PATCH 11/11] Update .github/ISSUE_TEMPLATE/feature_request.yml Co-authored-by: Tomoya Fujita Signed-off-by: Peter Borkuti --- .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index a2c65ce60..c20ad9d52 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,6 +1,6 @@ name: Feature request description: File a feature request. -labels: ["feature"] +labels: ["enhancement"] body: - type: markdown attributes: