Skip to content

Commit adb7e6b

Browse files
committed
test: Add form-based PR template for testing
1 parent 8bbf257 commit adb7e6b

2 files changed

Lines changed: 148 additions & 0 deletions

File tree

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<!--
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+
## 🔍 Type of Change
23+
- [ ] 🐛 Bug fix
24+
- [ ] ✨ New feature
25+
- [ ] 📚 Documentation
26+
- [ ] 🔧 Refactor
27+
- [ ] ⚡ Performance
28+
- [ ] 🧪 Example
29+
30+
## 📝 Description
31+
<!-- Brief description of what this PR does -->
32+
33+
## 🔗 Related Issues
34+
<!-- Link any related issues: Closes #123, Fixes #456 -->
35+
36+
## 🧪 Testing
37+
- [ ] Added/updated tests
38+
- [ ] All tests pass
39+
- [ ] Manual testing completed
40+
41+
## 📋 Checklist
42+
- [ ] Code follows project style guidelines
43+
- [ ] Self-review completed
44+
- [ ] Documentation updated (if needed)
45+
- [ ] License information added (if new files)
46+
47+
## 🖼️ Screenshots/Recordings
48+
<!-- If applicable, add screenshots or recordings to help explain your changes -->
49+
50+
---
51+
<sub>📖 [Contributing Guide](https://github.com/csrc-sdsu/mole/blob/master/CONTRIBUTING.md) • [Code of Conduct](https://github.com/csrc-sdsu/mole/blob/master/CODE_OF_CONDUCT.md)</sub>

.github/pull_request_template.yml

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
name: Pull Request
2+
description: Submit a pull request to contribute to MOLE
3+
title: "[Type]: Brief description of changes"
4+
labels: []
5+
body:
6+
- type: dropdown
7+
id: pr_type
8+
attributes:
9+
label: Type of Change
10+
description: What type of change does this PR introduce?
11+
options:
12+
- Bug fix 🐛
13+
- New feature ✨
14+
- Documentation 📚
15+
- Refactor 🔧
16+
- Performance optimization ⚡
17+
- Example 🧪
18+
- Other
19+
default: 0
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: description
25+
attributes:
26+
label: Description
27+
description: Provide a clear and concise description of what this PR does
28+
placeholder: Describe your changes...
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: related_issues
34+
attributes:
35+
label: Related Issues
36+
description: Link any related issues using GitHub keywords
37+
placeholder: "Closes #123, Fixes #456"
38+
validations:
39+
required: false
40+
41+
- type: dropdown
42+
id: tests_added
43+
attributes:
44+
label: Tests
45+
description: Have you added or updated tests for your changes?
46+
options:
47+
- Yes, tests added/updated
48+
- No tests needed
49+
- Need help with tests
50+
validations:
51+
required: true
52+
53+
- type: checkboxes
54+
id: checklist
55+
attributes:
56+
label: Pre-submission Checklist
57+
description: Please verify the following
58+
options:
59+
- label: Code follows project style guidelines
60+
required: true
61+
- label: Self-review of code completed
62+
required: true
63+
- label: All tests pass locally
64+
required: true
65+
- label: Documentation updated (if applicable)
66+
required: false
67+
- label: License information added for new files
68+
required: false
69+
70+
- type: textarea
71+
id: testing_instructions
72+
attributes:
73+
label: Testing Instructions
74+
description: How should reviewers test this change?
75+
placeholder: "1. Run tests with...\n2. Check that...\n3. Verify..."
76+
validations:
77+
required: false
78+
79+
- type: textarea
80+
id: screenshots
81+
attributes:
82+
label: Screenshots/Recordings
83+
description: If applicable, add visual evidence of your changes
84+
placeholder: Drag and drop images or paste links here
85+
validations:
86+
required: false
87+
88+
- type: checkboxes
89+
id: terms
90+
attributes:
91+
label: Contributing Guidelines
92+
description: By submitting this PR, you confirm that
93+
options:
94+
- label: I have read and followed the [Contributing Guide](https://github.com/csrc-sdsu/mole/blob/master/CONTRIBUTING.md)
95+
required: true
96+
- label: I have read and agree to the [Code of Conduct](https://github.com/csrc-sdsu/mole/blob/master/CODE_OF_CONDUCT.md)
97+
required: true

0 commit comments

Comments
 (0)