From 5d33942306c0bc7bfcb0e66061d14a2cbbce2008 Mon Sep 17 00:00:00 2001 From: Jan Gutsche Date: Thu, 23 Nov 2023 16:44:13 +0100 Subject: [PATCH] Update GitHub Issue and PR templates --- .github/ISSUE_TEMPLATE/1_bug_report.md | 20 ++++---------------- .github/ISSUE_TEMPLATE/2_feature_request.md | 13 ++++--------- .github/ISSUE_TEMPLATE/3_need_help.md | 10 +++------- .github/pull_request_template.md | 12 +++++++----- 4 files changed, 18 insertions(+), 37 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/1_bug_report.md b/.github/ISSUE_TEMPLATE/1_bug_report.md index fad4c55..cc12b25 100644 --- a/.github/ISSUE_TEMPLATE/1_bug_report.md +++ b/.github/ISSUE_TEMPLATE/1_bug_report.md @@ -1,11 +1,10 @@ --- name: "\U0001F41B Bug report" about: Report a misbehavior or other bug -title: '' labels: 'bug' -assignees: '' --- - +# Summary + ## Expected behavior @@ -15,21 +14,10 @@ assignees: '' ## Steps to Reproduce - + 1. 2. 3. -... - -## Context (Environment) - - -- [ ] RViz -- [ ] Simulator -- [ ] Robot -- [ ] Local ## Possible Solution - - - + diff --git a/.github/ISSUE_TEMPLATE/2_feature_request.md b/.github/ISSUE_TEMPLATE/2_feature_request.md index 4aad9e5..875cf49 100644 --- a/.github/ISSUE_TEMPLATE/2_feature_request.md +++ b/.github/ISSUE_TEMPLATE/2_feature_request.md @@ -3,14 +3,10 @@ name: "\U0001F680 Feature request" about: Suggest an idea for this project labels: 'enhancement' --- +# Summary + - - -## Is your feature request related to a problem? Please describe. +## Is your feature request related to a problem? ## Describe the solution you'd like @@ -18,5 +14,4 @@ Please fill in as much of the template below as you're able. ## Describe alternatives you've considered - - + diff --git a/.github/ISSUE_TEMPLATE/3_need_help.md b/.github/ISSUE_TEMPLATE/3_need_help.md index 75b65cd..48cba38 100644 --- a/.github/ISSUE_TEMPLATE/3_need_help.md +++ b/.github/ISSUE_TEMPLATE/3_need_help.md @@ -1,14 +1,11 @@ --- -name: "⁉️ Need help?" +name: "⁉️ Help me" about: "Get help with using or improving our software" -title: '' -labels: '' -assignees: '' +labels: 'question' --- - -## What I'm trying to do +# What I'm trying to do ## What I've tried @@ -16,4 +13,3 @@ assignees: '' ## Additional context - diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index ff7abe1..41cf5a8 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,3 +1,6 @@ +# Summary + + ## Proposed changes @@ -6,12 +9,11 @@ -## Necessary checks -- [ ] Update package version -- [ ] Run `catkin build` +## Checklist + +- [ ] Run `colcon build` - [ ] Write documentation - [ ] Create issues for future work - [ ] Test on your machine - [ ] Test on the robot -- [ ] Put the PR on our Project board - +- [ ] This PR is on our `Software` project board