|
1 | 1 | # Pull Request |
2 | 2 |
|
3 | | -## 📝 Description |
| 3 | +## Description |
4 | 4 |
|
5 | | -Please include a summary of the changes and the related issue. Include relevant motivation and context. |
| 5 | +Summary of the changes and the related issue. Include motivation and context. |
6 | 6 |
|
7 | | -Fixes # (issue) |
| 7 | +Closes # |
8 | 8 |
|
9 | | -## 🎯 Type of Change |
| 9 | +## Type of Change |
10 | 10 |
|
11 | | -Please delete options that are not relevant: |
| 11 | +- [ ] Bug fix |
| 12 | +- [ ] New feature |
| 13 | +- [ ] Breaking change |
| 14 | +- [ ] Documentation update |
| 15 | +- [ ] Code style update (formatting, renaming) |
| 16 | +- [ ] Code refactoring (no functional changes) |
| 17 | +- [ ] Performance improvement |
| 18 | +- [ ] Test update |
| 19 | +- [ ] Build / CI configuration |
| 20 | +- [ ] Security fix |
12 | 21 |
|
13 | | -- [ ] 🐛 Bug fix (non-breaking change which fixes an issue) |
14 | | -- [ ] ✨ New feature (non-breaking change which adds functionality) |
15 | | -- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected) |
16 | | -- [ ] 📝 Documentation update |
17 | | -- [ ] 🎨 Code style update (formatting, renaming) |
18 | | -- [ ] ♻️ Code refactoring (no functional changes) |
19 | | -- [ ] ⚡ Performance improvement |
20 | | -- [ ] ✅ Test update |
21 | | -- [ ] 🔧 Build/CI configuration |
22 | | -- [ ] 🔒 Security fix |
| 22 | +## How Has This Been Tested? |
23 | 23 |
|
24 | | -## 🧪 How Has This Been Tested? |
| 24 | +Describe the tests run to verify the changes: |
25 | 25 |
|
26 | | -Please describe the tests that you ran to verify your changes: |
| 26 | +- [ ] Unit tests |
| 27 | +- [ ] Manual testing |
27 | 28 |
|
28 | | -- [ ] Test A |
29 | | -- [ ] Test B |
30 | | - |
31 | | -**Test Configuration**: |
| 29 | +**Test Configuration:** |
32 | 30 | - Python version: |
33 | 31 | - Operating System: |
34 | 32 | - DockSec version: |
35 | 33 |
|
36 | | -## 📋 Checklist |
37 | | - |
38 | | -- [ ] My code follows the style guidelines of this project |
39 | | -- [ ] I have performed a self-review of my own code |
40 | | -- [ ] I have commented my code, particularly in hard-to-understand areas |
41 | | -- [ ] I have made corresponding changes to the documentation |
42 | | -- [ ] My changes generate no new warnings or errors |
43 | | -- [ ] I have added tests that prove my fix is effective or that my feature works |
44 | | -- [ ] New and existing unit tests pass locally with my changes |
45 | | -- [ ] Any dependent changes have been merged and published |
46 | | -- [ ] I have checked my code and corrected any misspellings |
47 | | - |
48 | | -## 📸 Screenshots (if applicable) |
| 34 | +## Checklist |
49 | 35 |
|
50 | | -Add screenshots to help explain your changes. |
| 36 | +- [ ] Code follows the style guidelines of this project |
| 37 | +- [ ] Self-review completed |
| 38 | +- [ ] Hard-to-understand areas are commented |
| 39 | +- [ ] Documentation updated where needed |
| 40 | +- [ ] No new warnings or errors introduced |
| 41 | +- [ ] Tests added that prove the fix or feature works |
| 42 | +- [ ] All existing tests pass |
| 43 | +- [ ] Dependent changes have been merged and published |
| 44 | +- [ ] Spelling checked |
51 | 45 |
|
52 | | -## 🔗 Related Issues/PRs |
| 46 | +## Screenshots (if applicable) |
53 | 47 |
|
54 | | -Link any related issues or pull requests: |
| 48 | +## Related Issues / PRs |
55 | 49 |
|
56 | 50 | - Relates to # |
57 | | -- Closes # |
58 | 51 | - Depends on # |
59 | 52 |
|
60 | | -## 📚 Additional Notes |
61 | | - |
62 | | -Any additional information that reviewers should know. |
63 | | - |
64 | 53 | --- |
65 | 54 |
|
66 | | -**By submitting this pull request, I confirm that my contribution is made under the terms of the MIT license.** |
| 55 | +By submitting this pull request, I confirm that my contribution is made under the terms of the MIT license. |
0 commit comments