|
| 1 | +markdown |
| 2 | + |
| 3 | +# NovaModuleTools PR Description Generator |
| 4 | + |
| 5 | +## Purpose |
| 6 | + |
| 7 | +Generate a complete, high-quality pull request description for NovaModuleTools based on a change summary, commits, or |
| 8 | +diff. |
| 9 | + |
| 10 | +The output MUST follow the NovaModuleTools PR template exactly and be concise, precise, and reviewer-focused. |
| 11 | + |
| 12 | +--- |
| 13 | + |
| 14 | +## Inputs |
| 15 | + |
| 16 | +- Change description, commit messages, or diff (required) |
| 17 | +- Optional: issue number, workflow touched, commands affected |
| 18 | + |
| 19 | +--- |
| 20 | + |
| 21 | +## Instructions |
| 22 | + |
| 23 | +Analyze the provided input and: |
| 24 | + |
| 25 | +1. Infer the intent of the change (bugfix, feature, refactor, CI, docs, etc.) |
| 26 | +2. Identify impacted areas (CLI, PowerShell, CI/CD, packaging, docs, etc.) |
| 27 | +3. Detect validation steps performed (or infer what should have been run) |
| 28 | +4. Highlight reviewer entry points (key files, workflows, or commands) |
| 29 | +5. Identify risks, breaking changes, or follow-ups |
| 30 | + |
| 31 | +Be pragmatic: if information is missing, make reasonable assumptions but call them out briefly. |
| 32 | + |
| 33 | +--- |
| 34 | + |
| 35 | +## Output format |
| 36 | + |
| 37 | +You MUST return the PR description using this exact structure: |
| 38 | + |
| 39 | +--- |
| 40 | + |
| 41 | +## Summary |
| 42 | + |
| 43 | +- What changed? |
| 44 | +- Why was this change needed? |
| 45 | +- Link the issue, discussion, or follow-up work (for example `Closes #123`). |
| 46 | + |
| 47 | +--- |
| 48 | + |
| 49 | +## Affected area |
| 50 | + |
| 51 | +Select all relevant: |
| 52 | + |
| 53 | +- [ ] `nova` CLI or command routing |
| 54 | +- [ ] Public PowerShell cmdlet behavior |
| 55 | +- [ ] Scaffolding or `project.json` handling |
| 56 | +- [ ] Build, test, analyzer, coverage, or CI helper flow |
| 57 | +- [ ] Package, raw upload, or package metadata workflow |
| 58 | +- [ ] Publish, release, semantic-release, or GitHub Actions automation |
| 59 | +- [ ] Self-update or notification preference behavior |
| 60 | +- [ ] Contributor documentation (`README.md`, `CONTRIBUTING.md`, repository workflow docs) |
| 61 | +- [ ] End-user docs (`docs/*.html`) |
| 62 | +- [ ] Command help (`docs/NovaModuleTools/en-US/*.md`) |
| 63 | +- [ ] `src/resources/example/` |
| 64 | +- [ ] Dependency or manifest changes (`package.json`, workflow dependencies, release tooling) |
| 65 | +- [ ] Security-sensitive change |
| 66 | +- [ ] Documentation-only change |
| 67 | +- [ ] Other |
| 68 | + |
| 69 | +--- |
| 70 | + |
| 71 | +## Review guidance |
| 72 | + |
| 73 | +- Highlight the main code path or workflow reviewers should start with. |
| 74 | +- Call out the primary files or folders changed (for example `src/public/`, `src/private/cli/`, `scripts/build/ci/`, |
| 75 | + `.github/workflows/`, `docs/`, or `src/resources/example/`). |
| 76 | +- Call out any trade-offs, follow-up work, or known limitations. |
| 77 | + |
| 78 | +--- |
| 79 | + |
| 80 | +## Validation |
| 81 | + |
| 82 | +Mark relevant checks: |
| 83 | + |
| 84 | +- [ ] `Invoke-NovaBuild` |
| 85 | +- [ ] `Test-NovaBuild` |
| 86 | +- [ ] `./scripts/build/Invoke-ScriptAnalyzerCI.ps1` |
| 87 | +- [ ] `./scripts/build/ci/Invoke-NovaModuleToolsCI.ps1` |
| 88 | +- [ ] Targeted Nova workflow validated (`% nova build`, `% nova test`, `% nova merge`, `% nova deploy`, |
| 89 | + `% nova publish`, |
| 90 | + `% nova release`, `% nova update`, `% nova notification`, or `% nova init` as relevant) |
| 91 | +- [ ] Docs/example only; executable validation not needed |
| 92 | + |
| 93 | +Validation notes: |
| 94 | + |
| 95 | +``` |
| 96 | +<Fill with commands, outputs, or justification> |
| 97 | +``` |
| 98 | + |
| 99 | +--- |
| 100 | + |
| 101 | +## Documentation and release follow-up |
| 102 | + |
| 103 | +- [ ] `README.md` reviewed and updated if needed |
| 104 | +- [ ] `CONTRIBUTING.md` reviewed and updated if needed |
| 105 | +- [ ] `CHANGELOG.md` reviewed and updated if relevant |
| 106 | +- [ ] Command help updated if CLI or cmdlets changed |
| 107 | +- [ ] End-user docs updated if workflows changed |
| 108 | +- [ ] Examples updated if real usage changed |
| 109 | +- [ ] No documentation updates needed |
| 110 | + |
| 111 | +--- |
| 112 | + |
| 113 | +## Maintainability, compatibility, and risk |
| 114 | + |
| 115 | +- [ ] Code Health / maintainability impact considered |
| 116 | +- [ ] No breaking change |
| 117 | +- [ ] Breaking change |
| 118 | +- [ ] Security-sensitive change |
| 119 | +- [ ] CI, workflow, or release-pipeline impact |
| 120 | +- [ ] Dependency-review impact |
| 121 | + |
| 122 | +Risk, rollout, or rollback notes: |
| 123 | + |
| 124 | +``` |
| 125 | +<Describe impact, migration, rollback, or follow-up> |
| 126 | +``` |
| 127 | + |
| 128 | +--- |
| 129 | + |
| 130 | +## Style rules |
| 131 | + |
| 132 | +- Be concise and technical (no fluff) |
| 133 | +- Prefer bullet points over paragraphs |
| 134 | +- Be explicit about workflows (especially CI/CD and release flow) |
| 135 | +- Always think like a reviewer: "Where do I start reading?" |
| 136 | +- Never leave sections empty — infer or justify |
| 137 | + |
| 138 | +--- |
| 139 | + |
| 140 | +## Example invocation |
| 141 | + |
| 142 | +Generate PR description from: |
| 143 | + |
| 144 | +- Commit: "fix: resolve ambiguous -w CLI parameter parsing" |
| 145 | +- Files changed: `src/private/cli/Invoke-NovaCli.ps1` |
| 146 | + |
| 147 | +--- |
| 148 | + |
| 149 | +## Expected behavior |
| 150 | + |
| 151 | +The output should be ready to paste directly into a GitHub PR without edits. |
0 commit comments