Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
15 lines (11 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

15 lines (11 loc) · 1.24 KB

Developing Kaboom

  1. npm install to install dev packages.
  2. npm run dev to start dev server. ~ to run npm run dev on Windows: change "dev": "NODE_ENV=development node scripts/dev.js" to "dev": "set NODE_ENV=development& node scripts/dev.js". Make sure to change back to original before commit.
  3. Go to http://localhost:8000/
  4. Pick on example to test and edit the corresponding /examples/[name].js, or create a new file under /examples to test anything you're working on.
  5. The source entry point is src/kaboom.ts, editing any files referenced will automatically trigger rebuild. Make sure not to break any existing examples.
  6. Before commit npm run check to check typescript, npm run lint to check eslint before commit, or use npm run fmt to auto format with eslint ~ to run npm run lint on Windows: change "linebreak-style": [ "error", "unix" ] to "linebreak-style": [ "error", "windows" ]. Make sure to change back to original before commit.

Documentation

Most kaboom docs are written in src/types.ts as jsDoc above each kaboom component entry.

Help on improving the documentation is appreciated! Thank you for contributing!