Skip to content

chore: Mention npm run build in CONTRIBUTING.md #232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 17, 2025
Merged

chore: Mention npm run build in CONTRIBUTING.md #232

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.