Skip to content

Latest commit

 

History

History
49 lines (26 loc) · 1.31 KB

ADMIN.md

File metadata and controls

49 lines (26 loc) · 1.31 KB
Raw

Administration

Few useful bullet points to administrate ic-js.

Table of contents

Create a new library

  1. Init a new workspace
npm init -w ./packages/a
  1. Setup the new package

Copy package.json, license.md, esbuild.mjs etc. files as in other libs. As for example from the cmc library.

Adapt package.json content.

  1. Configure did files

Add did source files import-candid and compile-idl-js.

  1. Generate did and js files

Run the scripts modified in last steps

  1. Implement

Implement a feature or at least provide a src/index.ts file in the new lib that contains at least an export {};.

  1. Docs

Add new library to docs generator and in package.json script docs to format the generated docs with prettier at the ends of the process.

  1. Update CI

Add new library to various CI workflows.

  1. Build, PR and merge

  2. Tags and release to npm

  3. Provide a new PR that bump version of all libs to start next version

  4. Merge and publish next to npm