ponsfrilus-commit-types

List of ponsfrilus commit types.

Usage no npm install needed!

<script type="module">
  import ponsfrilusCommitTypes from 'https://cdn.skypack.dev/ponsfrilus-commit-types';
</script>

README

ponsfrilus-commit-types

This is a fork from conventional-commit-types.

Status: npm version npm downloads Build Status

Spec

Exports an object with a types key whose value is an object whose keys are type names and whose values are objects with key-value pairs such as description as string, optional title as string, etc. See index.json. Any alternatives should follow the same spec.

Prefixes

I do like bracketed 3 letters capitalized prefixes. A good part of them are adapted from the original conventional-commit-types repo:

Type Meaning Description
[ADD] ADD When the project welcome new files
[BLD] BUILD Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
[BTF] BEAUTIFULLAGE Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
[C.I] CONTINUOUS INTEGRATION Changes to the CI configuration files and scripts
[DOC] DOCUMENTATION Documentation only changes
[FIX] FIX A bug fix
[FT.] FEATURE A new feature
[HOC] HOUSE CLEANING Changes that make the repository more clean (wiping, cleaning, mopping)
[IGN] IGNORE When adding a .gitignore file or similar
[OTH] OTHER Other changes that don't modify src or test files
[PRF] PERFORMANCE A code change that improves performance
[RFA] REFACTOR A code change that neither fixes a bug nor adds a feature
[RVT] REVERT Reverts a previous commit
[STY] STYLE Changes that mainly change the style, look and feel or visual appearance
[TAG] TAG When adding a tag reference
[TST] TEST Adding missing tests or correcting existing tests
[TYP] TYPO An error (as of spelling) in typed or typeset material
[T9N] TRANSLATION Anything related to Translation (T9N), Localization (L10N) or Internationalization (I18N)
[VER] VERSION Bump version
[WIP] WORK IN PROGRESS e.g. in case of fire

Please note they are sorted by prefixes in alphabetical order.

Infos

Installation

You will need commitizen and cz-ponsfrilus-changelog, which will install ponsfrilus-commit-types as a dependency:

commitizen
cz-ponsfrilus-changelog
└── ponsfrilus-commit-types

Run the following command to install them:
npm i -g commitizen cz-ponsfrilus-changelog

Then, if you want to set the "ponsfrilus-commit-types" as default, you will have to create the .czrc file:

$ cat ~/.czrc
{ "path": "cz-ponsfrilus-changelog" }

You can run the following command to create it:
echo '{ "path": "cz-ponsfrilus-changelog" }' > ~/.czrc

ToDo