refactor(cli): reword command help and capitalize the first characters

tests/commands/test_bump_command/test_bump_command_shows_description_when_use_help_option.txt

@@ -1,81 +1,60 @@
-usage: cz bump [-h] [--dry-run] [--files-only] [--local-version] [--changelog]
-               [--no-verify] [--yes] [--tag-format TAG_FORMAT]
-               [--bump-message BUMP_MESSAGE] [--prerelease {alpha,beta,rc}]
-               [--devrelease DEVRELEASE] [--increment {MAJOR,MINOR,PATCH}]
-               [--increment-mode {linear,exact}] [--check-consistency]
-               [--annotated-tag]
-               [--annotated-tag-message ANNOTATED_TAG_MESSAGE] [--gpg-sign]
-               [--changelog-to-stdout] [--git-output-to-stderr] [--retry]
-               [--major-version-zero] [--template TEMPLATE] [--extra EXTRA]
-               [--file-name FILE_NAME] [--prerelease-offset PRERELEASE_OFFSET]
-               [--version-scheme {pep440,semver,semver2}]
-               [--version-type {pep440,semver,semver2}]
-               [--build-metadata BUILD_METADATA] [--get-next]
-               [--allow-no-commit]
+usage: cz bump [-h] [--dry-run] [--files-only] [--local-version] [--changelog] [--no-verify] [--yes] [--tag-format TAG_FORMAT] [--bump-message BUMP_MESSAGE] [--prerelease {alpha,beta,rc}] [--devrelease DEVRELEASE]
+               [--increment {MAJOR,MINOR,PATCH}] [--increment-mode {linear,exact}] [--check-consistency] [--annotated-tag] [--annotated-tag-message ANNOTATED_TAG_MESSAGE] [--gpg-sign] [--changelog-to-stdout]
+               [--git-output-to-stderr] [--retry] [--major-version-zero] [--template TEMPLATE] [--extra EXTRA] [--file-name FILE_NAME] [--prerelease-offset PRERELEASE_OFFSET]
+               [--version-scheme {pep440,semver,semver2}] [--version-type {pep440,semver,semver2}] [--build-metadata BUILD_METADATA] [--get-next] [--allow-no-commit]
                [MANUAL_VERSION]
 
-bump semantic version based on the git log
+Bump semantic version based on the git log
 
 positional arguments:
-  MANUAL_VERSION        bump to the given version (e.g: 1.5.3)
+  MANUAL_VERSION        Bump to the specified version (e.g: 1.5.3)
 
 options:
   -h, --help            show this help message and exit
-  --dry-run             show output to stdout, no commit, no modified files
-  --files-only          bump version in the files from the config
-  --local-version       bump only the local version portion
-  --changelog, -ch      generate the changelog for the newest version
-  --no-verify           this option bypasses the pre-commit and commit-msg
-                        hooks
-  --yes                 accept automatically questions done
+  --dry-run             Show output to stdout, no commit, no modified files
+  --files-only          Bump version in the files from the config
+  --local-version       Bump only the local version portion
+  --changelog, -ch      Generate the changelog for the newest version
+  --no-verify           Bypass the pre-commit and commit-msg hooks
+  --yes                 Accept automatically questions done
   --tag-format TAG_FORMAT
-                        the format used to tag the commit and read it, use it
-                        in existing projects, wrap around simple quotes
+                        The format used to tag the commit and read it, use it in existing projects, wrap around simple quotes
   --bump-message BUMP_MESSAGE
-                        template used to create the release commit, useful
-                        when working with CI
+                        Template for creating the release commit message, useful in CI/CD pipelines
   --prerelease, -pr {alpha,beta,rc}
-                        choose type of prerelease
+                        Choose the type of prerelease
   --devrelease, -d DEVRELEASE
-                        specify non-negative integer for dev. release
+                        Specify a non-negative integer for dev. release
   --increment {MAJOR,MINOR,PATCH}
-                        manually specify the desired increment
+                        Specify a desired increment
   --increment-mode {linear,exact}
-                        set the method by which the new version is chosen.
-                        'linear' (default) guesses the next version based on
-                        typical linear version progression, such that bumping
-                        of a pre-release with lower precedence than the
-                        current pre-release phase maintains the current phase
-                        of higher precedence. 'exact' applies the changes that
-                        have been specified (or determined from the commit
-                        log) without interpretation, such that the increment
-                        and pre-release are always honored
+                        Set the method by which the new version is chosen. 'linear' (default) resolves the next version by following typical linear version progression, ensuring that bumping a pre-release with lower
+                        precedence than the current pre-release phase keeps the current phase of higher precedence. 'exact' applies the changes that have been specified (or determined from the commit log) without
+                        interpretation, ensuring that the increment and pre-release are always honored
   --check-consistency, -cc
-                        check consistency among versions defined in commitizen
-                        configuration and version_files
-  --annotated-tag, -at  create annotated tag instead of lightweight one
+                        Check consistency among versions defined in `version_files`
+  --annotated-tag, -at  Create an annotated tag instead of a lightweight one
   --annotated-tag-message, -atm ANNOTATED_TAG_MESSAGE
-                        create annotated tag message
-  --gpg-sign, -s        sign tag instead of lightweight one
+                        Create an annotated tag message
+  --gpg-sign, -s        Sign the tag instead of a lightweight one
   --changelog-to-stdout
-                        Output changelog to the stdout
+                        Output the changelog to the stdout
   --git-output-to-stderr
-                        Redirect git output to stderr
-  --retry               retry commit if it fails the 1st time
-  --major-version-zero  keep major version at zero, even for breaking changes
+                        Redirect Git output to stderr
+  --retry               Retry the commit after first failure
+  --major-version-zero  Keep the major version at zero, even for breaking changes
   --template, -t TEMPLATE
-                        changelog template file name (relative to the current
-                        working directory)
+                        changelog template file name (relative to the current working directory)
   --extra, -e EXTRA     a changelog extra variable (in the form 'key=value')
   --file-name FILE_NAME
-                        file name of changelog (default: 'CHANGELOG.md')
+                        File name of the changelog (default: 'CHANGELOG.md')
   --prerelease-offset PRERELEASE_OFFSET
-                        start pre-releases with this offset
+                        Start pre-releases with this offset
   --version-scheme {pep440,semver,semver2}
-                        choose version scheme
+                        Choose the version scheme
   --version-type {pep440,semver,semver2}
-                        Deprecated, use --version-scheme instead
+                        Deprecated, use `--version-scheme` instead
   --build-metadata BUILD_METADATA
-                        Add additional build-metadata to the version-number
-  --get-next            Determine the next version and write to stdout
-  --allow-no-commit     bump version without eligible commits
+                        Add additional build-metadata to the version number
+  --get-next            Output the next version to stdout
+  --allow-no-commit     Bump the version even when there are no eligible commits

tests/commands/test_changelog_command/test_changelog_command_shows_description_when_use_help_option.txt

@@ -1,41 +1,29 @@
-usage: cz changelog [-h] [--dry-run] [--file-name FILE_NAME]
-                    [--unreleased-version UNRELEASED_VERSION] [--incremental]
-                    [--start-rev START_REV] [--merge-prerelease]
-                    [--version-scheme {pep440,semver,semver2}]
-                    [--export-template EXPORT_TEMPLATE] [--template TEMPLATE]
-                    [--extra EXTRA] [--tag-format TAG_FORMAT]
+usage: cz changelog [-h] [--dry-run] [--file-name FILE_NAME] [--unreleased-version UNRELEASED_VERSION] [--incremental] [--start-rev START_REV] [--merge-prerelease] [--version-scheme {pep440,semver,semver2}]
+                    [--export-template EXPORT_TEMPLATE] [--template TEMPLATE] [--extra EXTRA] [--tag-format TAG_FORMAT]
                     [rev_range]
 
-generate changelog (note that it will overwrite existing file)
+Generate changelog (note that it will overwrite existing file)
 
 positional arguments:
-  rev_range             generates changelog for the given version (e.g: 1.5.3)
-                        or version range (e.g: 1.5.3..1.7.9)
+  rev_range             Generate changelog for the given version (e.g: 1.5.3) or version range (e.g: 1.5.3..1.7.9)
 
 options:
   -h, --help            show this help message and exit
-  --dry-run             show changelog to stdout
+  --dry-run             Show the changelog to stdout
   --file-name FILE_NAME
-                        file name of changelog (default: 'CHANGELOG.md')
+                        File name of the changelog (default: 'CHANGELOG.md')
   --unreleased-version UNRELEASED_VERSION
-                        set the value for the new version (use the tag value),
-                        instead of using unreleased
-  --incremental         generates changelog from last created version, useful
-                        if the changelog has been manually modified
+                        Set the value for the new version (use the tag value), instead of using unreleased
+  --incremental         Generate changelog from last created version, useful if the changelog has been manually modified
   --start-rev START_REV
-                        start rev of the changelog. If not set, it will
-                        generate changelog from the start
-  --merge-prerelease    collect all changes from prereleases into next non-
-                        prerelease. If not set, it will include prereleases in
-                        the changelog
+                        Start rev of the changelog. If not set, it will generate changelog from the start
+  --merge-prerelease    Collect all changes from prereleases into next non-prerelease. If not set, it will include prereleases in the changelog
   --version-scheme {pep440,semver,semver2}
-                        choose version scheme
+                        Choose the version scheme
   --export-template EXPORT_TEMPLATE
-                        Export the changelog template into this file instead
-                        of rendering it
+                        Export the changelog template to this file instead of rendering it
   --template, -t TEMPLATE
-                        changelog template file name (relative to the current
-                        working directory)
+                        changelog template file name (relative to the current working directory)
   --extra, -e EXTRA     a changelog extra variable (in the form 'key=value')
   --tag-format TAG_FORMAT
                         The format of the tag, wrap around simple quotes

tests/commands/test_check_command/test_check_command_shows_description_when_use_help_option.txt

@@ -1,28 +1,19 @@
-usage: cz check [-h] [--commit-msg-file COMMIT_MSG_FILE |
-                --rev-range REV_RANGE | -d | -m MESSAGE] [--allow-abort]
-                [--allowed-prefixes [ALLOWED_PREFIXES ...]]
-                [-l MESSAGE_LENGTH_LIMIT]
+usage: cz check [-h] [--commit-msg-file COMMIT_MSG_FILE | --rev-range REV_RANGE | -d | -m MESSAGE] [--allow-abort] [--allowed-prefixes [ALLOWED_PREFIXES ...]] [-l MESSAGE_LENGTH_LIMIT]
 
-validates that a commit message matches the commitizen schema
+Validates that a commit message matches the commitizen schema
 
 options:
   -h, --help            show this help message and exit
   --commit-msg-file COMMIT_MSG_FILE
-                        ask for the name of the temporal file that contains
-                        the commit message. Using it in a git hook script:
-                        MSG_FILE=$1
+                        Ask for the name of the temporal file that contains the commit message. Using it in a git hook script: MSG_FILE=$1
   --rev-range REV_RANGE
-                        a range of git rev to check. e.g, master..HEAD
+                        A range of git rev to check. e.g, master..HEAD
   -d, --use-default-range
-                        check from the default branch to HEAD. e.g,
-                        refs/remotes/origin/master..HEAD
+                        Validate all the commits on the default branch up to HEAD, e.g., refs/remotes/origin/master..HEAD
   -m, --message MESSAGE
-                        commit message that needs to be checked
-  --allow-abort         allow empty commit messages, which typically abort a
-                        commit
+                        Only validate the given commit message
+  --allow-abort         Allow empty commit messages, which typically abort a commit
   --allowed-prefixes [ALLOWED_PREFIXES ...]
-                        allowed commit message prefixes. If the message starts
-                        by one of these prefixes, the message won't be checked
-                        against the regex
+                        Ignore commit messages that start with one of these prefixes
   -l, --message-length-limit MESSAGE_LENGTH_LIMIT
-                        length limit of the commit message; 0 for no limit
+                        Maximum length of the commit message; 0 for no limit

tests/commands/test_commit_command/test_commit_command_shows_description_when_use_help_option.txt

@@ -1,22 +1,17 @@
-usage: cz commit [-h] [--retry] [--no-retry] [--dry-run]
-                 [--write-message-to-file FILE_PATH] [-s] [-a] [-e]
-                 [-l MESSAGE_LENGTH_LIMIT] [--]
+usage: cz commit [-h] [--retry] [--no-retry] [--dry-run] [--write-message-to-file FILE_PATH] [-s] [-a] [-e] [-l MESSAGE_LENGTH_LIMIT] [--]
 
-create new commit
+Create a new commit
 
 options:
   -h, --help            show this help message and exit
-  --retry               retry last commit
-  --no-retry            skip retry if retry_after_failure is set to true
-  --dry-run             show output to stdout, no commit, no modified files
+  --retry               Retry the last commit
+  --no-retry            Skip retry if retry_after_failure is set to true
+  --dry-run             Show output to stdout, no commit, no modified files
   --write-message-to-file FILE_PATH
-                        write message to file before committing (can be
-                        combined with --dry-run)
-  -s, --signoff         Deprecated, use 'cz commit -- -s' instead
-  -a, --all             Tell the command to automatically stage files that
-                        have been modified and deleted, but new files you have
-                        not told Git about are not affected.
-  -e, --edit            edit the commit message before committing
+                        Write message to file before committing (can be combined with --dry-run)
+  -s, --signoff         Deprecated, use `cz commit -- -s` instead
+  -a, --all             Automatically stage all tracked files that have been modified and deleted
+  -e, --edit            Edit the commit message before committing
   -l, --message-length-limit MESSAGE_LENGTH_LIMIT
-                        length limit of the commit message; 0 for no limit
-  --                    Positional arguments separator (recommended)
+                        Maximum length of the commit message; 0 for no limit
+  --                    Separator for positional arguments, e.g. `cz commit -- --allow-empty`

tests/commands/test_example_command/test_example_command_shows_description_when_use_help_option.txt

@@ -1,6 +1,6 @@
 usage: cz example [-h]
 
-show commit example
+Show commit example
 
 options:
   -h, --help  show this help message and exit

tests/commands/test_info_command/test_info_command_shows_description_when_use_help_option.txt

@@ -1,6 +1,6 @@
 usage: cz info [-h]
 
-show information about the cz
+Show information about the Commitizen
 
 options:
   -h, --help  show this help message and exit

tests/commands/test_init_command/test_init_command_shows_description_when_use_help_option.txt

@@ -1,6 +1,6 @@
 usage: cz init [-h]
 
-init commitizen configuration
+Initialize commitizen configuration
 
 options:
   -h, --help  show this help message and exit

tests/commands/test_ls_command/test_ls_command_shows_description_when_use_help_option.txt

@@ -1,6 +1,6 @@
 usage: cz ls [-h]
 
-show available commitizens
+Show available Commitizens
 
 options:
   -h, --help  show this help message and exit

tests/commands/test_schema_command/test_schema_command_shows_description_when_use_help_option.txt

@@ -1,6 +1,6 @@
 usage: cz schema [-h]
 
-show commit schema
+Show commit schema
 
 options:
   -h, --help  show this help message and exit

tests/commands/test_version_command/test_version_command_shows_description_when_use_help_option.txt

@@ -1,16 +1,16 @@
 usage: cz version [-h] [-r | -p | -c | -v] [--major | --minor]
 
-get the version of the installed commitizen or the current project (default:
+Get the version of the installed commitizen or the current project (default:
 installed commitizen)
 
 options:
   -h, --help        show this help message and exit
-  -r, --report      get system information for reporting bugs
-  -p, --project     get the version of the current project
-  -c, --commitizen  get the version of the installed commitizen
-  -v, --verbose     get the version of both the installed commitizen and the
-                    current project
-  --major           get just the major version. Need to be used with --project
-                    or --verbose.
-  --minor           get just the minor version. Need to be used with --project
-                    or --verbose.
+  -r, --report      Output system information for reporting bugs
+  -p, --project     Output the version of the current project
+  -c, --commitizen  Output the version of the installed commitizen
+  -v, --verbose     Output the version of both the installed commitizen and
+                    the current project
+  --major           Output just the major version. Need to be used with
+                    --project or --verbose.
+  --minor           Output just the minor version. Need to be used with
+                    --project or --verbose.