-
Notifications
You must be signed in to change notification settings - Fork 222
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(contributing.md): update contributing.md instructions (#834)
- Loading branch information
Showing
1 changed file
with
8 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,15 @@ | ||
| ## Developing Kaboom | ||
|
|
||
| 1. `npm install` to install dev packages | ||
| 1. `npm run dev` to start dev server | ||
| 1. `npm install` to install dev packages. | ||
| 1. `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**. | ||
| 1. Go to http://localhost:8000/ | ||
| 1. 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 | ||
| 1. The source entry point is `src/kaboom.ts`, editting any files referenced will automatically trigger rebuild | ||
| 1. Make sure not to break any existing examples | ||
| 1. 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 | ||
| 1. 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. | ||
| 1. The source entry point is `src/kaboom.ts`, editing any files referenced will automatically trigger rebuild. **Make sure not to break any existing examples**. | ||
| 1. 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 entry. Help on improving the documentation is appreciated! | ||
| Most kaboom docs are written in `src/types.ts` as [jsDoc](https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html) above each kaboom component entry. | ||
|
|
||
| Documentations are rendered on the kaboom website under `/site`. To build the website | ||
|
|
||
| - `npm run build` to build kaboom and generate `site/doc.json` | ||
| - `cd site` | ||
| - `npm install` if haven't already | ||
| - `npm run dev` to start nextjs dev server | ||
| - go to http://localhost:3000 | ||
| **Help on improving the documentation is appreciated! Thank you for contributing!** |