Skip to content

Commit ff599f9

Browse files
committed
feat: Add TODOs to the generated manifest file and update instructions to mention them
1 parent 2ba0e7f commit ff599f9

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

src/ScriptModuleRepositoryTemplate/TemplateRepoFiles/ReadMe.md

+1
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,7 @@ Coming soon.
123123
The following boilerplate git repository files should be reviewed and updated or removed as needed.
124124

125125
- [__NewModuleName__.psd1](/src/__NewModuleName__/__NewModuleName__.psd1): Update the module manifest with your module's information, such as the Description and have the ProjectUri link to this repository, etc.
126+
- If using the default generated manifest, search for "TODO" to find the properties that are recommended to update.
126127
- [Changelog](/Changelog.md): If you don't plan to track a changelog, remove this file and it's reference from the ReadMe.
127128
- [License](/License.md): Update to match your module's license, and ensure it uses the correct name and year in the copyright.
128129
- [Contributing](/docs/Contributing.md): Update to match your module's contributing guidelines, or remove it.

src/ScriptModuleRepositoryTemplate/TemplateRepoFiles/src/__NewModuleName__/__NewModuleName__.psd1

+7-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
# Script module or binary module file associated with this manifest.
66
RootModule = '__NewModuleName__.psm1'
77

8-
# Version number of this module.
8+
# Version number of this module. This will be updated automatically by the build and deployment pipelines.
99
ModuleVersion = '0.0.0'
1010

1111
# Supported PSEditions
@@ -24,6 +24,7 @@
2424
Copyright = '(c) __IndividualOrOrganizationName__. All rights reserved.'
2525

2626
# Description of the functionality provided by this module
27+
# TODO: Update the description and delete this TODO comment.
2728
Description = '__NewModuleName__ module.'
2829

2930
# Minimum version of the PowerShell engine required by this module
@@ -62,7 +63,8 @@
6263
# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
6364
# NestedModules = @()
6465

65-
# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
66+
# Functions to export from this module. For best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
67+
# TODO: Update the functions list and delete this TODO comment.
6668
FunctionsToExport = @(
6769
'Get-HelloWorld'
6870
)
@@ -91,12 +93,15 @@
9193
PSData = @{
9294

9395
# Tags applied to this module. These help with module discovery in online galleries.
96+
# TODO: Add appropriate module tags and delete this TODO comment.
9497
# Tags = @()
9598

9699
# A URL to the license for this module.
100+
# TODO: Add a link to the module license and delete this TODO comment.
97101
# LicenseUri = ''
98102

99103
# A URL to the main website for this project.
104+
# TODO: Add a link to your git repository or website and delete this TODO comment.
100105
# ProjectUri = ''
101106

102107
# A URL to an icon representing this module.

0 commit comments

Comments
 (0)