Skip to content

CleanroomMC/cleanroom-website

Repository files navigation

Cleanroom

This is where the entire site is stored, and to keep the repository tidy, please contribute as follows.

How to Contribute

  1. Clone the GitHub.
  2. Install pnpm.
  3. Run pnpm i on the project to download the required development dependencies to node_modules.
  4. Run pnpm dev to launch the localhost server.
  5. Run pnpm build to confirm that all links are valid.
  6. Thank you for contributing!

Optional Steps

Setup cz-git

If you don't know what this is, check out here.

TL;DR

npm install -g cz-git commitizen
echo '{ "path": "cz-git", "$schema": "https://cdn.jsdelivr.net/gh/Zhengqbbb/[email protected]/docs/public/schema/cz-git.json" }' > ~/.czrc

replace ~/.czrc to

{
    "path": "cz-git",
    "$schema": "https://cdn.jsdelivr.net/gh/Zhengqbbb/[email protected]/docs/public/schema/cz-git.json",
    "markBreakingChangeMode": true
}