chore: add guide on how to install conventional commits hook on local machine
This commit is contained in:
parent
7249c197ec
commit
bc6c356a60
1 changed files with 26 additions and 11 deletions
37
README.md
37
README.md
|
|
@ -33,17 +33,26 @@ With this template, you get all the awesomeness you need:
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
- [Features](#-features)
|
- [Next.js Enterprise Boilerplate](#nextjs-enterprise-boilerplate)
|
||||||
- [Getting Started](#-getting-started)
|
- [📚 Features](#-features)
|
||||||
- [Deployment](#-deployment)
|
- [Table of Contents](#table-of-contents)
|
||||||
- [Scripts Overview](#-scripts-overview)
|
- [🎯 Getting Started](#-getting-started)
|
||||||
- [Coupling Graph](#-coupling-graph)
|
- [🚀 Deployment](#-deployment)
|
||||||
- [Testing](#-testing)
|
- [📃 Scripts Overview](#-scripts-overview)
|
||||||
- [Styling and Design System](#-styling-and-design-system)
|
- [🔗 Coupling Graph](#-coupling-graph)
|
||||||
- [State Management](#-state-management)
|
- [🧪 Testing](#-testing)
|
||||||
- [ChatGPT Code Review](#-chatgpt-code-review)
|
- [Running Tests](#running-tests)
|
||||||
- [Contribution](#-contribution)
|
- [Acceptance Tests](#acceptance-tests)
|
||||||
- [License](#-license)
|
- [Smoke Testing](#smoke-testing)
|
||||||
|
- [🎨 Styling and Design System](#-styling-and-design-system)
|
||||||
|
- [CVA - A New Approach to Variants](#cva---a-new-approach-to-variants)
|
||||||
|
- [💾 State Management](#-state-management)
|
||||||
|
- [Zustand](#zustand)
|
||||||
|
- [Jotai](#jotai)
|
||||||
|
- [Recoil](#recoil)
|
||||||
|
- [🤖 ChatGPT Code Review](#-chatgpt-code-review)
|
||||||
|
- [🤝 Contribution](#-contribution)
|
||||||
|
- [📜 License](#-license)
|
||||||
|
|
||||||
## 🎯 Getting Started
|
## 🎯 Getting Started
|
||||||
|
|
||||||
|
|
@ -70,6 +79,12 @@ yarn dev
|
||||||
|
|
||||||
4. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
4. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
||||||
|
|
||||||
|
5. This project uses a git hook to enforce [conventional commits](https://github.com/qoomon/git-conventional-commits). To install the git hook, run the following command in the root directory of the project:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
brew install pre-commit
|
||||||
|
pre-commit install -t commit-msg
|
||||||
|
```
|
||||||
|
|
||||||
## 🚀 Deployment
|
## 🚀 Deployment
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue