0.0.9 • Published 5 years ago

ponsfrilus-commit-types v0.0.9

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

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:

TypeMeaningDescription
[ADD]ADDWhen the project welcome new files
[BLD]BUILDChanges that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
[BTF]BEAUTIFULLAGEChanges that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
[C.I]CONTINUOUS INTEGRATIONChanges to the CI configuration files and scripts
[DOC]DOCUMENTATIONDocumentation only changes
[FIX]FIXA bug fix
[FT.]FEATUREA new feature
[HOC]HOUSE CLEANINGChanges that make the repository more clean (wiping, cleaning, mopping)
[IGN]IGNOREWhen adding a .gitignore file or similar
[OTH]OTHEROther changes that don't modify src or test files
[PRF]PERFORMANCEA code change that improves performance
[RFA]REFACTORA code change that neither fixes a bug nor adds a feature
[RVT]REVERTReverts a previous commit
[STY]STYLEChanges that mainly change the style, look and feel or visual appearance
[TAG]TAGWhen adding a tag reference
[TST]TESTAdding missing tests or correcting existing tests
[TYP]TYPOAn error (as of spelling) in typed or typeset material
[T9N]TRANSLATIONAnything related to Translation (T9N), Localization (L10N) or Internationalization (I18N)
[VER]VERSIONBump version
[WIP]WORK IN PROGRESSe.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

0.0.9

5 years ago

0.0.8

5 years ago

0.0.7

5 years ago

0.0.5

5 years ago

0.0.4

5 years ago

0.0.2

5 years ago

0.0.1

5 years ago