diff --git a/README.md b/README.md index 5bb0641e..c92230e4 100644 --- a/README.md +++ b/README.md @@ -101,9 +101,19 @@ For example, if name is CRUD BLOC See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. -tl;dr : `type(scope): description` where type can be **feat, fix, docs, chores, ci, perf, refactor, style, test**, and scope is package name. +tl;dr : `type(scope): description`. +Here allowed values: -examples: +- **feat** for a new feature for the user, not a new feature for build script. Such commit will trigger a release bumping a MINOR version. +- **fix** for a bug fix for the user, not a fix to a build script. Such commit will trigger a release bumping a PATCH version. +- **perf** for performance improvements. Such commit will trigger a release bumping a PATCH version. +- **docs** for changes to the documentation. +- **style** for formatting changes, missing semicolons, etc. +- **refactor** for refactoring production code, e.g. renaming a variable. +- **test** for adding missing tests, refactoring tests; no production code change. +- **build** for updating build configuration, development tools or other changes irrelevant to the user. + +Some examples : - `feat(auth): add AWS support.` = add a feature in authentication_bloc package. - `docs: update readme.` = update **this** readme file.