Home

Welcome to the wiki page

Here we have usage instructions and customization documentation.

Using commit with the default pattern

The default commit pattern is an old version of angular commit message format, but you can make a custom pattern and send it to the command to override the default, see the customization section of the wiki.

In your terminal, you can just pass the command commit and the command will give you a selection of types of commits.

- What type of commit you will made?
> feat - A new feature
  fix - A bug fix
  docs - Documentation only changes
  style - Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  refactor - A code change that neither fixes a bug nor adds a feature
  perf - A code change that improves performance
v test - Adding missing tests or correcting existing tests
[↑↓ to move, enter to select, type to filter]

When you select a type, the command will ask you if you want to add a scope.

- What type of commit you will made? feat - A new feature
- What scope of commit you will made? (Optional)
> custom - Custom scope
  none - No scope
[↑↓ to move, enter to select, type to filter]

In the default configuration file, there are no default scopes because it will depend on the project you are working on.

If you select custom, the program will ask you to enter the scope name, after that it will ask you to enter the commit description.

- What type of commit you will made? feat - A new feature
- What scope of commit you will made? (Optional) none - No scope
- Write a SHORT, IMPERATIVE tense description of the change:

Afterward that, it will give you the option to put a message body.

- What type of commit you will made? feat - A new feature
- What scope of commit you will made? (Optional) none - No scope
- Write a SHORT, IMPERATIVE tense description of the change: Now you can use commit to padronize commits in your repo
- Provide a LONGER description of the change (optional):
[Commit body. Press Enter to skip]

Afterward that, the command will give you the option to put a footer message.

- What type of commit you will made? feat - A new feature
- What scope of commit you will made? (Optional) none - No scope
- Write a SHORT, IMPERATIVE tense description of the change: Now you can use commit to padronize commits in your repo
- Provide a LONGER description of the change (optional):
- List any ISSUES CLOSED by this change (optional). E.g.: #31, #34:
[Commit footer. Press Enter to skip]

After that, the command will ask you if you want to apply the commit.

- What type of commit you will made? feat - A new feature
- What scope of commit you will made? (Optional) none - No scope
- Write a SHORT, IMPERATIVE tense description of the change: Now you can use commit to padronize commits in your repo
- Provide a LONGER description of the change (optional):
- List any ISSUES CLOSED by this change (optional). E.g.: #31, #34: #2

The commit message is:

feat: Now you can use commit to padronize commits in your repo

#2

- Do you want to apply the commit? (Y/n)