Skip to content

Commit b0534da

Browse files
author
Jan Gutsche
committed
Update GitHub Issue and PR templates
1 parent 46f6d9c commit b0534da

File tree

4 files changed

+18
-37
lines changed

4 files changed

+18
-37
lines changed
+4-16
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
---
22
name: "\U0001F41B Bug report"
33
about: Report a misbehavior or other bug
4-
title: ''
54
labels: 'bug'
6-
assignees: ''
75
---
8-
<!--- Provide a general summary of the issue in the Title above -->
6+
# Summary
7+
<!--- Provide a general summary of the bug report -->
98

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

1615
## Steps to Reproduce
1716
<!--- An unambiguous set of steps to reproduce this bug. -->
18-
<!--- Code-snippets, screenshots ot other details are welcome if needed. -->
17+
<!--- Code-snippets, screenshots or other details are welcome if needed. -->
1918
1.
2019
2.
2120
3.
22-
...
23-
24-
## Context (Environment)
25-
<!--- Providing context helps us nail down where the issue might be located. -->
26-
<!--- 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. -->
27-
- [ ] RViz
28-
- [ ] Simulator
29-
- [ ] Robot
30-
- [ ] Local
3121

3222
## Possible Solution
33-
<!--- NOT OBLIGATORY -->
34-
<!--- If you already have an idea, you can suggest a fix/reason for the bug -->
35-
23+
<!--- Optional: If you already have an idea, you can suggest a fix/reason for the bug -->

.github/ISSUE_TEMPLATE/2_feature_request.md

+4-9
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,15 @@ name: "\U0001F680 Feature request"
33
about: Suggest an idea for this project
44
labels: 'enhancement'
55
---
6+
# Summary
7+
<!--- Provide a general summary of the feature request -->
68

7-
<!--
8-
Thank you for suggesting an idea to make us better.
9-
10-
Please fill in as much of the template below as you're able.
11-
-->
12-
13-
## Is your feature request related to a problem? Please describe.
9+
## Is your feature request related to a problem?
1410
<!-- Please describe the problem you are trying to solve. -->
1511

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

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

.github/ISSUE_TEMPLATE/3_need_help.md

+3-7
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,15 @@
11
---
2-
name: "⁉️ Need help?"
2+
name: "⁉️ Help me"
33
about: "Get help with using or improving our software"
4-
title: ''
5-
labels: ''
6-
assignees: ''
4+
labels: 'question'
75
---
8-
96
<!--- 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] -->
107

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

1411
## What I've tried
1512
<!--- 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.-->
1613

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

.github/pull_request_template.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# Summary
2+
<!--- Provide a general summary of the changes -->
3+
14
## Proposed changes
25
<!--- Describe your changes and why they are necessary. -->
36

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

9-
## Necessary checks
10-
- [ ] Update package version
11-
- [ ] Run `catkin build`
12+
## Checklist
13+
14+
- [ ] Run `colcon build`
1215
- [ ] Write documentation
1316
- [ ] Create issues for future work
1417
- [ ] Test on your machine
1518
- [ ] Test on the robot
16-
- [ ] Put the PR on our Project board
17-
19+
- [ ] This PR is on our `Software` project board

0 commit comments

Comments
 (0)