Skip to content
This repository has been archived by the owner on Dec 26, 2023. It is now read-only.

Make all short descriptions of commands start with capitalized letters #83

Open
vieiralucas opened this issue Sep 12, 2023 · 5 comments
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@vieiralucas
Copy link
Member

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 vieiralucas added enhancement New feature or request good first issue Good for newcomers labels Sep 12, 2023
@vieiralucas
Copy link
Member Author

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.

@SaumyaBhushan
Copy link
Contributor

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

@sushant102004
Copy link

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

@SaumyaBhushan
Copy link
Contributor

Sure @sushant102004 you can take it.

@sushant102004
Copy link

Okay Thank You!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants