layerform icon indicating copy to clipboard operation
layerform copied to clipboard

Make all `short` descriptions of commands start with capitalized letters

Open vieiralucas opened this issue 1 year ago • 5 comments

It is currently inconsistent, some commands start with capital letters other not. We should make sure all commands short descriptions start with capitalized letters.

Current output of layerform --help

> layerform --help
Layerform helps engineers create their own staging environments using plain Terraform files.

Please read our documentation at https://docs.layerform.dev for more information.

Usage:
  layerform [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  configure   transforms layer definition configurations in an actual layer definition file
  help        Help about any command
  kill        destroys a layer instance
  list        List layerform resources
  output      reads all output variables from the provided layer instance
  refresh     refreshes a layer instance
  spawn       creates a layer instance

Flags:
  -h, --help      help for layerform
  -v, --version   version for layerform

Use "layerform [command] --help" for more information about a command.

Desired output:

> layerform --help
Layerform helps engineers create their own staging environments using plain Terraform files.

Please read our documentation at https://docs.layerform.dev for more information.

Usage:
  layerform [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  configure   transforms layer definition configurations in an actual layer definition file
  help        Help about any command
  kill        Destroys a layer instance
  list        List layerform resources
  output      Reads all output variables from the provided layer instance
  refresh     Refreshes a layer instance
  spawn       Creates a layer instance

Flags:
  -h, --help      help for layerform
  -v, --version   version for layerform

Use "layerform [command] --help" for more information about a command.

vieiralucas avatar Sep 12 '23 04:09 vieiralucas

This should be a pretty easy one, just search the codebase for the words. They will all be inside cli/<command>.go Just update the Short field of each command to have the letters capitalized.

vieiralucas avatar Sep 12 '23 04:09 vieiralucas

Hi @vieiralucas ! Can I work on this one or is it for new contributors?

SaumyaBhushan avatar Sep 12 '23 05:09 SaumyaBhushan

Hi, I'm new to open source contribution. Can I work on this issue? I want to make my 1st open source contribution.

x-sushant-x avatar Sep 12 '23 06:09 x-sushant-x

Sure @sushant102004 you can take it.

SaumyaBhushan avatar Sep 12 '23 06:09 SaumyaBhushan

Okay Thank You!

x-sushant-x avatar Sep 12 '23 07:09 x-sushant-x