From 62a683c465fc2ecf95c56a068ce72ec74710cb23 Mon Sep 17 00:00:00 2001 From: Peter Borkuti Date: Fri, 24 May 2024 19:52:52 +0200 Subject: [PATCH] Add templates Signed-off-by: Peter Borkuti --- .github/ISSUE_TEMPLATE/bug_report.yml | 84 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 11 +++ .github/ISSUE_TEMPLATE/feature_request.yml | 20 ++++++ 3 files changed, 115 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..6317aa634 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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 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