@velocitycareerlabs/template-package

Introduction

The package contains the minimum starting point, of what defines a package for us.

New Package Creation Instructions

Steps

1. This directory should be copied and renamed to the package name. The "name" field in the package.json should be updated to match the directory name, prefixed by @velocitycareerlabs as seen by the template-package name: "@velocitycareerlabs/template-package"

2. A description should be added in the "description" field in the package.json

3. This README.md should be cleared and used for relevant information in the new package.

Some points to take note of:

• "repository" field in package.json is important and is used later when we setup scopes with lerna

• They packages actually get published, but we don't consume the packages directly from their publish location, instead we rely on lerna cli within the repository like so:

  lerna add [CONSUMED-PACKAGE-NAME] --scope [CONSUMING-PACKAGE-NAME]

  So if you want did-docs package to use the crypto package, you would do:

  lerna add @velocitycareerlabs/crypto --scope @velocitycareerlabs/did-docs

• Packages uses standard structure, of src directory, and then test directory for corresponding tests

• Tests can be run from package.json script

• Tests will be automatically included in global test suite and run in CI