โ— REC Skynet Industries (TM) Termlink ยท Public terminal 7 ยท Surveillance active ยท Monitored for your safety

Contribute to Krascha

Want to teach Krascha a new trick? Fork the repo, make your change and send a pull request. Krascha is watching.

  1. 1 ๐Ÿด Fork it

    Click Fork on shanep/krascha. That gives you your own copy on GitHub to break.

  2. 2 ๐Ÿ“ฅ Clone it and set up

    You need git and Node 22 or newer.

    git clone https://github.com/YOUR-NAME/krascha.git
    cd krascha
    npm install

    npm install also turns on the pre-commit hook. It runs the typecheck, the tests and the build before every commit, so you find out before CI does.

  3. 3 ๐ŸŒฟ Make a branch and make your change

    git switch -c count-gosh

    The plugin is in src/ and this site is in worker/. Add a test for whatever you change. To try it out:

    npm run build
    node dist/cli.js
  4. 4 ๐Ÿ”„ Keep your fork up to date

    Other people land changes while you work. Pull them in before you open the pull request, and again if master moves while you wait.

    git remote add upstream https://github.com/shanep/krascha.git
    git fetch upstream
    git rebase upstream/master

    You only need the git remote add line once.

  5. 5 ๐Ÿ“ฆ Commit, bundle included

    Run npm run build and commit dist/cli.js along with your change. The plugin runs the committed bundle, so a change without it does nothing.

    git add -A
    git commit -m "Count gosh as a swear"

    Write the message as a command: "Count gosh as a swear", not "Counted gosh".

  6. 6 ๐Ÿ“ฌ Push and open a pull request

    git push origin count-gosh

    Then open a pull request from your branch to master on shanep/krascha. Say what it does and why. CI runs the same checks on macOS and Linux, and Shane reviews it from there.