From 5274b17af68d0f62aef753e09bbd46ea56db35ff Mon Sep 17 00:00:00 2001 From: Liu Xiaoyi Date: Fri, 17 Oct 2025 07:41:39 +0800 Subject: [PATCH] chore: Mention `npm run build` in CONTRIBUTING.md --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index affedb6..3f120b0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,7 +3,8 @@ - Fork the repository on Github. - Clone the repository locally. - Make your changes to the code. -- Run `npm install`. +- Run `npm install` and `npm run build`. - Run `npm link` which creates a symlink and thereby `docsify` can be accessed globally. +- After each edit, rerun `npm run build` so the new executable would be globally available. - We use [commitlint conventional naming rules](https://www.npmjs.com/package/@commitlint/config-conventional#rules) for our commits, make sure that you follow them. - Push to Github and open a pull request.