Skip to content

Latest commit

 

History

History
35 lines (30 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

35 lines (30 loc) · 1.21 KB

Contributing

kord.js is a monorepo and its tooling has been chosen to simplify the process of building and testing packages simultaneously, whilst remaining light and transparent:

  • 🃏 Jest - used to run tests for all packages simultaneously.
  • 🐉 Lerna - purely included for the run command, which enables an npm script to be executed in each package that contains that script. This repo is not classed as a Lerna repo.
  • 📦 NPM Scoped Packages - naming convention used so packages can be published individually while under the scope of the wider library.
  • 🗞 Rollup - used to run the build process and bundle modules into a distributable library.
  • 🐈 Yarn Workspaces - used to manage package dependencies and symlinking. All new dependencies should be installed with yarn add [--dev].

Setup

yarn install

Build

yarn build

Test

yarn test