Skip to content

PBSA/lightMVP-front

Repository files navigation

Streamers Edge Light

Commitizen friendly Conventional Commits

Technology Stack

  • React
  • Redux (single source of truth state management)
  • Redux dev tools (allow user to debug )
  • ESlint (to ensure code style consistency)
  • Commitlint (to ensure commit message adhere to Conventional Commits)

Commits

If you have run the init script, you can commit via git cz.
If you have not run the init script, you must commit via npm run commit.
If you do neither, commit message consistency will be difficult for you.

This repository uses a combination of tools to aid in consistent commit messages. The reason we do this is so we can have dynamic changelog creation and smart semantic versioning based on commits (with the ability to override).

The following tools are used:

  1. commitizen
    Used for prompting recommended entries within a commit message to ensure it contains the necessary information.
  2. husky
    By using the hooks from this package we intercept commits being made and verify them with commitlint.
    • Prevent bad commits/pushes.
  3. commitlint

Releases

This repository uses a standard version to aid in version control and release management.

When using standard version to cut a release, there is automated changelog modifitions made based on commit messages.

// If you typically use npm version to cut a new release, do this instead:
npm run release