Skip to content

Commit 4cdccf7

Browse files
committed
feat: Create modern, streamlined PR template
1 parent adb7e6b commit 4cdccf7

1 file changed

Lines changed: 43 additions & 64 deletions

File tree

Lines changed: 43 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,46 @@
11
<!--
2-
Before submitting a Pull Request, please ensure you've done the following:
3-
- πŸ“– Read the MOLE Contributing Guide: https://github.com/csrc-sdsu/mole/blob/master/CONTRIBUTING.md
4-
- πŸ“– Read the MOLE Code of Conduct: https://github.com/csrc-sdsu/mole/blob/master/CODE_OF_CONDUCT.md
5-
- πŸ‘·β€β™€οΈ Create small PRs. In most cases this will be possible.
6-
- βœ… Provide tests for your changes.
7-
- πŸ“ Use descriptive commit messages.
8-
- πŸ“— Update any related documentation and include any relevant screenshots.
9-
- πŸ“ Add license information in the appropriate place. See MATLAB or C++ code for reference.
10-
11-
SPDX-License-Identifier: GPL-3.0-or-later
12-
Β© 2008-2024 San Diego State University Research Foundation (SDSURF).
13-
See LICENSE file or https://www.gnu.org/licenses/gpl-3.0.html for details.
14-
15-
NOTE: Pull Requests from forked repositories need to be reviewed by
16-
a MOLE Team member before any CI builds will run.
17-
18-
For a timely review/response, please avoid force-pushing additional
19-
commits if your PR already received reviews or comments.
20-
-->
21-
22-
## What type of PR is this? (check all applicable)
23-
24-
- [ ] Refactor
25-
- [ ] Feature
26-
- [ ] Bug Fix
27-
- [ ] Optimization
28-
- [ ] Example
29-
- [ ] Documentation
30-
31-
## Description
32-
33-
## Related Issues & Documents
34-
35-
<!--
36-
For Pull Requests that relate or close an Issue, please include them
37-
below. We like to follow [Github's guidance on linking issues to pull requests](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
38-
39-
For example having the text: "closes #1234" would connect the current pull
40-
request to issue 1234. And when we merge the pull request, Github will
41-
automatically close the issue.
2+
πŸš€ Thanks for contributing to MOLE!
3+
πŸ“– Please read our Contributing Guide: https://github.com/csrc-sdsu/mole/blob/master/CONTRIBUTING.md
4+
πŸ“– Code of Conduct: https://github.com/csrc-sdsu/mole/blob/master/CODE_OF_CONDUCT.md
425
-->
43-
- Closes #
44-
45-
## QA Instructions, Screenshots, Recordings
46-
47-
_Please replace this line with instructions on how to test your changes, a note
48-
on the devices and browsers this has been tested on, as well as any relevant
49-
images for UI changes._
50-
51-
## Added/updated tests?
52-
_We encourage you to test all code included with MOLE, including examples.
53-
54-
- [ ] Yes
55-
- [ ] No, and this is why: _please replace this line with details on why tests
56-
have not been included_
57-
- [ ] I need help with writing tests
58-
59-
## Read Contributing Guide and Code of Conduct
60-
61-
- [ ] I have read and followed the [Contributing Guide](https://github.com/csrc-sdsu/mole/blob/master/CONTRIBUTING.md) and the [Code of Conduct](https://github.com/csrc-sdsu/mole/blob/master/CODE_OF_CONDUCT.md)
62-
63-
## [optional] Are there any post deployment tasks we need to perform?
64-
65-
## [optional] What gif best describes this PR or how it makes you feel?
666

67-
<img src="https://miro.medium.com/v2/1*VpQb2kbPdj6vXH2pJqi7Qg.gif" width="100" height="100" />
7+
## πŸ” Type of Change
8+
<!-- Replace [ ] with [x] to select -->
9+
- [ ] πŸ› Bug fix
10+
- [ ] ✨ New feature
11+
- [ ] πŸ“š Documentation
12+
- [ ] πŸ”§ Refactor
13+
- [ ] ⚑ Performance optimization
14+
- [ ] πŸ§ͺ Example
15+
16+
## πŸ“ Summary
17+
<!-- Brief description of what this PR does -->
18+
19+
## πŸ”— Related Issues
20+
<!-- Link related issues: "Closes #123" or "Fixes #456" -->
21+
22+
## πŸ§ͺ Testing
23+
<!-- Replace [ ] with [x] for what applies -->
24+
- [ ] βœ… Tests added/updated
25+
- [ ] βœ… All tests pass
26+
- [ ] βœ… Manual testing completed
27+
- [ ] ❌ No tests needed
28+
29+
## πŸ“‹ Checklist
30+
<!-- Replace [ ] with [x] when completed -->
31+
- [ ] Code follows project style guidelines
32+
- [ ] Self-review completed
33+
- [ ] Documentation updated (if needed)
34+
- [ ] License info added (for new files)
35+
36+
## πŸ” Testing Instructions
37+
<!-- How should reviewers test this? -->
38+
1.
39+
2.
40+
3.
41+
42+
## πŸ“Έ Screenshots/Recordings
43+
<!-- Drag images here or paste links -->
44+
45+
---
46+
<sub>By submitting this PR, I confirm I've read the [Contributing Guide](https://github.com/csrc-sdsu/mole/blob/master/CONTRIBUTING.md) and [Code of Conduct](https://github.com/csrc-sdsu/mole/blob/master/CODE_OF_CONDUCT.md)</sub>

0 commit comments

Comments
Β (0)