Skip to content
This repository was archived by the owner on Feb 23, 2021. It is now read-only.
This repository was archived by the owner on Feb 23, 2021. It is now read-only.

Consider including README.md in NewAdvancedPowerShellModule #2

@RamblingCookieMonster

Description

@RamblingCookieMonster

Hi!

From my perspective, every module (whether you house it on GitHub, an internal system, anywhere) should have a README.md to at the very least, provide:

  • What is this
  • Prerequisites
  • How to install
  • Example(s) of common scenario(s)

Also... less critical, but potentially helpful, you might consider some basic simple format folks can start from (perhaps including a common install/discovery snippet with Install-Module ModuleName, Get-Help about_ModuleName, Get-Command -Module ModuleName`, etc.

Cheers!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions