url-signing icon indicating copy to clipboard operation
url-signing copied to clipboard

feat: add PowerShell module signing example with README.md

Open edwardspurlock opened this issue 4 years ago • 2 comments

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> 🦕

edwardspurlock avatar Dec 18 '21 20:12 edwardspurlock

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 avatar Jan 19 '22 22:01 edwardspurlock

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 <moduleName> 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)?

edwardspurlock avatar Feb 01 '22 23:02 edwardspurlock