|
| 1 | +# Description |
| 2 | + |
| 3 | +<!-- Provide a brief description of the changes in this PR --> |
| 4 | + |
| 5 | +## Type of Change |
| 6 | + |
| 7 | +<!-- Mark the relevant option with an 'x' --> |
| 8 | + |
| 9 | +- [ ] Bug fix (non-breaking change which fixes an issue) |
| 10 | +- [ ] New feature (non-breaking change which adds functionality) |
| 11 | +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) |
| 12 | +- [ ] Documentation update |
| 13 | +- [ ] Code refactoring |
| 14 | +- [ ] Performance improvement |
| 15 | +- [ ] Test improvement |
| 16 | + |
| 17 | +## Semantic Versioning |
| 18 | + |
| 19 | +<!-- Include the appropriate keyword in your commit message to control versioning --> |
| 20 | + |
| 21 | +- [ ] `+semver: major` - Breaking changes (1.0.0 → 2.0.0) |
| 22 | +- [ ] `+semver: minor` - New features (1.0.0 → 1.1.0) |
| 23 | +- [ ] `+semver: patch` - Bug fixes (1.0.0 → 1.0.1) |
| 24 | +- [ ] `+semver: none` - No version change (documentation, tests) |
| 25 | + |
| 26 | +## Checklist |
| 27 | + |
| 28 | +<!-- Mark completed items with an 'x' --> |
| 29 | + |
| 30 | +### Code Quality |
| 31 | + |
| 32 | +- [ ] Code follows PowerShell best practices and approved verbs |
| 33 | +- [ ] All functions include `[CmdletBinding()]` attribute |
| 34 | +- [ ] Parameter validation attributes are used appropriately |
| 35 | +- [ ] Proper error handling with try/catch blocks is implemented |
| 36 | +- [ ] Verbose output is provided for troubleshooting |
| 37 | +- [ ] No hard-coded paths, credentials, or sensitive data |
| 38 | + |
| 39 | +### Testing |
| 40 | + |
| 41 | +- [ ] All new functions have corresponding `.Tests.ps1` files |
| 42 | +- [ ] Existing tests pass: `Invoke-Build Test` |
| 43 | +- [ ] New tests added for new functionality |
| 44 | +- [ ] Code coverage is adequate |
| 45 | +- [ ] Edge cases are tested (null/empty inputs) |
| 46 | + |
| 47 | +### Code Analysis |
| 48 | + |
| 49 | +- [ ] PSScriptAnalyzer passes: `Invoke-Build Invoke-PSScriptAnalyzer` |
| 50 | +- [ ] No new PSScriptAnalyzer warnings introduced |
| 51 | +- [ ] Security checks pass (InjectionHunter tests) |
| 52 | + |
| 53 | +### Documentation |
| 54 | + |
| 55 | +- [ ] Comment-based help is complete and accurate |
| 56 | +- [ ] Markdown help files updated (if function signatures changed) |
| 57 | +- [ ] Examples included in help documentation |
| 58 | +- [ ] README.md updated (if applicable) |
| 59 | +- [ ] CHANGELOG.md updated (if applicable) |
| 60 | + |
| 61 | +### Module Manifest |
| 62 | + |
| 63 | +- [ ] New public functions added to `FunctionsToExport` in `.psd1` |
| 64 | +- [ ] Module manifest version updated (if applicable) |
| 65 | + |
| 66 | +## Related Issues |
| 67 | + |
| 68 | +<!-- Link related issues using #issue_number or 'Fixes #issue_number' for auto-closing --> |
| 69 | + |
| 70 | +Closes # |
| 71 | + |
| 72 | +## Additional Notes |
| 73 | + |
| 74 | +<!-- Add any additional context, screenshots, or information about the PR here --> |
0 commit comments