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

Update GitHub Issue and PR templates #29

Merged
merged 1 commit into from
Nov 23, 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
20 changes: 4 additions & 16 deletions .github/ISSUE_TEMPLATE/1_bug_report.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
name: "\U0001F41B Bug report"
about: Report a misbehavior or other bug
title: ''
labels: 'bug'
assignees: ''
---
<!--- Provide a general summary of the issue in the Title above -->
# Summary
<!--- Provide a general summary of the bug report -->

## Expected behavior
<!--- Describe what you expected to happen -->
Expand All @@ -15,21 +14,10 @@ assignees: ''

## Steps to Reproduce
<!--- An unambiguous set of steps to reproduce this bug. -->
<!--- Code-snippets, screenshots ot other details are welcome if needed. -->
<!--- Code-snippets, screenshots or other details are welcome if needed. -->
1.
2.
3.
...

## Context (Environment)
<!--- Providing context helps us nail down where the issue might be located. -->
<!--- The below checklist is not a must-fill-out but rather a guideline what can be interesting here. You're welcome to write additional text as well. -->
- [ ] RViz
- [ ] Simulator
- [ ] Robot
- [ ] Local

## Possible Solution
<!--- NOT OBLIGATORY -->
<!--- If you already have an idea, you can suggest a fix/reason for the bug -->

<!--- Optional: If you already have an idea, you can suggest a fix/reason for the bug -->
13 changes: 4 additions & 9 deletions .github/ISSUE_TEMPLATE/2_feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,15 @@ name: "\U0001F680 Feature request"
about: Suggest an idea for this project
labels: 'enhancement'
---
# Summary
<!--- Provide a general summary of the feature request -->

<!--
Thank you for suggesting an idea to make us better.

Please fill in as much of the template below as you're able.
-->

## Is your feature request related to a problem? Please describe.
## Is your feature request related to a problem?
<!-- Please describe the problem you are trying to solve. -->

## Describe the solution you'd like
<!-- Please describe the desired behavior. -->

## Describe alternatives you've considered
<!-- Please describe alternative solutions or features you have considered. -->
<!-- This is not strictly neccessary but helps all of us get a different point-of-view -->

<!-- This is not strictly necessary but helps all of us get a different point-of-view -->
10 changes: 3 additions & 7 deletions .github/ISSUE_TEMPLATE/3_need_help.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,15 @@
---
name: "⁉️ Need help?"
name: "⁉️ Help me"
about: "Get help with using or improving our software"
title: ''
labels: ''
assignees: ''
labels: 'question'
---

<!--- If you have a question about any of our projects that is not a bug report or feature request, you can write us an issue like this or send a message to [email protected] -->

## What I'm trying to do
# What I'm trying to do
<!--- Please describe what you're trying to do so we know what your problem is about -->

## What I've tried
<!--- If you tell us what you already tried or what documentation you already read, we are able to help you better by not pointing to information you already know.-->

## Additional context
<!--- If there's more to say, feel free to do so :) -->

12 changes: 7 additions & 5 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Summary
<!--- Provide a general summary of the changes -->

## Proposed changes
<!--- Describe your changes and why they are necessary. -->

Expand All @@ -6,12 +9,11 @@
<!--- If you suggest a new feature, please discuss it in an issue first. -->
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->

## 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