| 1 | # Contributing
|
| 2 |
|
| 3 | ## Creating a Plugin
|
| 4 |
|
| 5 | Canon is a monorepo, with plugins stored in the `packages/` folder. To get started creating a new plugin:
|
| 6 |
|
| 7 | 1. Create a new branch to work in (usually `<name>-0.1`).
|
| 8 | 2. Create a new subfolder `packages/<name>`
|
| 9 | 3. Initialize a `package.json` and add `@datawheel/canon-core` to both the devDependencies and the peerDependencies
|
| 10 | 4. Run `npx canon-setup` to create a boilerplate canon site to test your plugin (these files will not get published to npm).
|
| 11 | 5. Create a `src/` folder to store your code!
|