Skip to content

Commit 9f7bec7

Browse files
authored
Simplify templates for issues and pull requests (#25)
1 parent 754bea6 commit 9f7bec7

2 files changed

Lines changed: 33 additions & 32 deletions

File tree

.github/ISSUE_TEMPLATE/issue.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,20 @@ labels: enhancement
66
assignees: ''
77
---
88

9-
# Feature request / General issue
9+
## Summary
1010

11-
Please describe the request or issue:
11+
Briefly describe the problem or the feature you’re requesting.
1212

13-
### Proposal
13+
---
1414

15-
Describe the change or feature you would like to see.
15+
## Proposed solution (optional)
1616

17-
### Motivation
17+
How do you think this could be solved?
1818

19-
Why is this change important? Who does it benefit?
19+
<!-- If you’re not sure, you can leave this empty. -->
2020

21-
### Alternatives considered
21+
---
2222

23-
Other options or implementations you considered.
23+
## Additional context (optional)
2424

25-
### Additional context
26-
Add any other context or screenshots about the feature request here.
25+
Any extra details, links, screenshots, etc.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,38 @@
11
# Pull Request
22

3-
<!-- Thank you for contributing to ros2_medkit! Please fill out this template to help us review your PR. -->
3+
<!-- Thanks for contributing to ros2_medkit! -->
44

5-
## Description
5+
## Summary
66

7-
What changed and why.
7+
Briefly describe what changed and why.
88

9-
## Type of change
9+
---
1010

11-
- [ ] Bug fix (non-breaking change which fixes an issue)
12-
- [ ] New feature (non-breaking change which adds functionality)
13-
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14-
- [ ] Documentation update
11+
## Issue
1512

16-
## Related issues
13+
Link the related issue (required):
1714

18-
Fixes #<issue number> (if applicable)
19-
Related to #<issue number> (if applicable)
15+
- closes #<issue number>
2016

21-
## How has this been tested?
17+
---
2218

23-
Describe the tests you ran to verify your changes.
19+
## Type
2420

25-
## Checklist
21+
- [ ] Bug fix
22+
- [ ] New feature or tests
23+
- [ ] Breaking change
24+
- [ ] Documentation only
25+
26+
---
27+
28+
## Testing
2629

27-
- [ ] My code follows the project's coding style
28-
- [ ] I ran `colcon build` and the build succeeds without warnings
29-
- [ ] I ran `colcon test` and all tests pass locally
30-
- [ ] I added/updated tests where applicable
31-
- [ ] I updated documentation where applicable
32-
- [ ] My commit messages are clear and descriptive
30+
How was this tested / how should reviewers verify it?
3331

34-
## Additional notes for reviewers
32+
---
33+
34+
## Checklist
3535

36-
<!-- Add any additional information that would help reviewers understand your changes -->
36+
- [ ] Breaking changes are clearly described (and announced in docs / changelog if needed)
37+
- [ ] Tests were added or updated if needed
38+
- [ ] Docs were updated if behavior or public API changed

0 commit comments

Comments
 (0)