Skip to content

feat: add PowerShell module signing example with README.md#29

Open
edwardspurlock wants to merge 3 commits intogooglemaps:gh-pagesfrom
edwardspurlock:powershell
Open

feat: add PowerShell module signing example with README.md#29
edwardspurlock wants to merge 3 commits intogooglemaps:gh-pagesfrom
edwardspurlock:powershell

Conversation

@edwardspurlock
Copy link

Thank you for opening a Pull Request!


Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

  • Make sure to open a GitHub issue as a bug/feature request before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
  • Ensure the tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • Appropriate docs were updated (if necessary)

Fixes #<issue_number_goes_here> 🦕

Copy link
Member

@wangela wangela left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for contributing a new sample with documentation. This PR contains a README but the PowerShell module that it refers to is not present. They would ideally be submitted together. If there is only one file (the .psm1 file) required to use PowerShell, consider adding that file to the root and modifying the top-level README to have a PowerShell section rather than creating a sub-directory with its own README. Also, to follow the convention of other samples in this repo, consider naming the module urlSigner.psm1

@edwardspurlock
Copy link
Author

I have no idea what happened to the other files that should have been part of the pull request.

I can change the module name from "staticSigner" to "urlSigner" - would it be better to close this pull request and open a new one after I've made the change to the file and README ?

@edwardspurlock
Copy link
Author

edwardspurlock commented Feb 1, 2022

I changed the name of the module and its enclosing folder to URLsigner to match the names of the other code samples.

PowerShell modules consist of a directory that contains at least one .psm1 file with the same name:
< moduleName >/< moduleName >.psm1

I've used this structure for the URLsigner/URLsigner.psm1 module.

I created the README.md and supporting image files inside the URLsigner directory, since the directory is available to keep them separate from the other code sample files. However, do you think it would be better to remove the extended README and supporting image files for the PowerShell module, and just have the minimum amount of code (like the other code samples)?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments