Skip to content

What's in the box?

Lam Ngoc Khuong edited this page Nov 30, 2023 · 16 revisions

Table of contents


GitHub Actions

GitHub Actions makes it easy to automate all your software workflows, now with world-class CI/CD. Build, test, and deploy your code right from GitHub. Make code reviews, branch management, and issue triaging work the way you want.

CI workflow file:

Senmatic PR workflow file: .github/workflows/check-semantic-prs.yml


ESLint

ESLint is a fully pluggable tool for identifying and reporting on patterns in JavaScript.

Configuration file:

For more configuration options and details, see the configuration docs.


Prettier

Prettier is an opinionated code formatter.

Configuration file:

For more configuration options and details, see the configuration docs.


Husky

Husky is a package that helps you create Git hooks easily.

Configuration folder: .husky.


Lint-staged

Lint-staged is a Node.js script that allows you to run arbitrary scripts against currently staged files.

Configuration file:


Commitizen

commitizen is a command line utility that makes it easier to create commit messages following the conventional commit format specification.

Use git cz instead of git commit to use commitizen.

Add and commit with Commitizen

Configuration file: package.json.


Commitlint

commitlint checks if your commit messages meet the conventional commit format.

Configuration file: commitlint.config.js.

In general, the pattern mostly looks like this:

type(scope?): subject  #scope is optional

Are you a good commitizen?


References

Clone this wiki locally