Skip to content

Commit 9b5824f

Browse files
authored
Merge pull request #21 from bit-bots/feature/github_templates
github: add issue and pr templates
2 parents 8657ea6 + 2931b14 commit 9b5824f

File tree

4 files changed

+94
-0
lines changed

4 files changed

+94
-0
lines changed
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: "\U0001F41B Bug report"
3+
about: Report a missbehavior or other bug
4+
title: ''
5+
labels: 'bug'
6+
assignees: ''
7+
---
8+
<!--- Provide a general summary of the issue in the Title above -->
9+
10+
## Expected behavior
11+
<!--- Describe what you expected to happen -->
12+
13+
## Current behavior
14+
<!--- Describe what actually happened instead of the expected behavior -->
15+
16+
## Steps to Reproduce
17+
<!--- An unambiguous set of steps to reproduce this bug. -->
18+
<!--- Code-snippets, screenshots ot other details are welcome if needed. -->
19+
1.
20+
2.
21+
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
31+
32+
## Possible Solution
33+
<!--- NOT OBLIGATORY -->
34+
<!--- If you already have an idea, you can suggest a fix/reason for the bug -->
35+
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: "\U0001F680 Feature request"
3+
about: Suggest an idea for this project
4+
labels: 'enhancement'
5+
---
6+
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.
14+
<!-- Please describe the problem you are trying to solve. -->
15+
16+
## Describe the solution you'd like
17+
<!-- Please describe the desired behavior. -->
18+
19+
## Describe alternatives you've considered
20+
<!-- 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+

.github/ISSUE_TEMPLATE/3_need_help.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: "⁉️ Need help?"
3+
about: "Get help with using or improving our software"
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
---
8+
9+
<!--- 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 info@bit-bots.de -->
10+
11+
## What I'm trying to do
12+
<!--- Please describe what you're trying to do so we know what your problem is about -->
13+
14+
## What I've tried
15+
<!--- 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.-->
16+
17+
## Additional context
18+
<!--- If there's more to say, feel free to do so :) -->
19+

.github/pull_request_template.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<!--- Provide a general summary of your changes in the Title above -->
2+
3+
## Proposed changes
4+
<!--- Describe your changes and why they are necessary. -->
5+
6+
## Related issues
7+
<!--- Mention (link) related issues. -->
8+
<!--- If you suggest a new feature, please discuss it in an issue first. -->
9+
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
10+
11+
## Necessary checks
12+
- [ ] Update package version
13+
- [ ] Run linters
14+
- [ ] Run `catkin build`
15+
- [ ] Write documentation
16+
- [ ] Test on your machine
17+
- [ ] Test on the robot
18+

0 commit comments

Comments
 (0)