From b58cab1c07b53f928bca1659a50a749f63219503 Mon Sep 17 00:00:00 2001 From: Cotes Chung <11371340+cotes2020@users.noreply.github.com> Date: Sun, 13 Mar 2022 16:50:12 +0800 Subject: [PATCH] docs: update contributing guidelines --- .github/CONTRIBUTING.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index b35638a..9ac13dc 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -45,6 +45,22 @@ $ npx gulp dev After debugging, run the command `npx gulp` (without any argument) will automatically output the compressed files to the directory `assets/js/dist/`. +## Verify the commit messages + +If you want to make sure your commits pass the CI check, you can refer to the following steps. + +Install `commitlint` & `husky`: + +```console +$ npm i -g @commitlint/{cli,config-conventional} husky +``` + +And then enable `husky`: + +```console +$ husky install +``` + --- :tada: Your volunteering will make the open-source world more beautiful, thanks again! :tada: