freepik-company / gommitizen

A commitizen written in go for monorepo
MIT License
8 stars 1 forks source link

refactor(docs): Improve examples in README and CLI #64

Closed sergiotejon closed 1 week ago

sergiotejon commented 1 week ago

CLI Example:

Increment the version of the project according to the conventional commits specification.

Usage:
  gommitizen bump [flags]

Examples:
# To bump the version of a project, run:
gommitizen bump
# This will bump the version of all projects in the current directory.
# If you want to bump the version of a specific project, run:
gommitizen bump -d <directory>
# This will bump the version of the project in the given directory.
# If you want to bump the version of projects and generate a changelog, run:
gommitizen bump -c
# This will bump the version of the projects and generate a changelog with the changes made since the last version.
# If you want to bump the version of project to a major version, run:
gommitizen bump -i major

Flags:
  -c, --changelog          generate the changelog for the newest version
  -h, --help               help for bump
  -i, --increment string   manually specify the desired increment {MAYOR, MINOR, PATCH}

Global Flags:
      --debug              Enable debug
  -d, --directory string   Select a directory to run the command

README example:

Examples of usage:

# To bump the version of a project, run:
gommitizen bump
# This will bump the version of all projects in the current directory.

# If you want to bump the version of a specific project, run:
gommitizen bump -d <directory>
# This will bump the version of the project in the given directory.

# If you want to bump the version of projects and generate a changelog, run:
gommitizen bump -c
# This will bump the version of the projects and generate a changelog with the changes made since the last version.

# If you want to bump the version of project to a major version, run:
gommitizen bump -i major
sergiotejon commented 1 week ago

Acabo de ver un cagada de un perfecto castellano:

  -i, --increment string   manually specify the desired increment {---> MAYOR <----, MINOR, PATCH}
jaimeph commented 1 week ago

Sigo viéndolo así, ¿es correcto?

Captura de pantalla 2024-11-19 a las 9 36 47

sergiotejon commented 1 week ago

Sigo viéndolo así, ¿es correcto?

Captura de pantalla 2024-11-19 a las 9 36 47

No debería :( ... te has movido a la rama?