Skip to content

Contribute

We welcome contributions! This monorepo includes both the CLI and the website. Follow the steps below to get set up.

  1. Clone the repository

    Terminal window
    git clone https://github.com/saif-shines/hacksmith.git
    cd hacksmith
  2. Install dependencies

    Terminal window
    pnpm install
  3. Common workflows

    Terminal window
    # Build everything
    pnpm build:all
    # Website development (Starlight/Astro)
    pnpm site:dev
    # CLI development
    pnpm --filter hacksmith dev
    # or watch/build
    pnpm --filter hacksmith build:watch
  4. Adding dependencies

    Terminal window
    # Add to CLI only
    pnpm --filter hacksmith add <package>
    # Add to website only
    pnpm --filter @hacksmith/website add <package>
    # Add dev dependency to all workspaces
    pnpm -r add -D <package>
  5. Commit conventions

    We use Conventional Commits enforced by commitlint. Prettier and ESLint run via pre-commit hooks.