0.0.2 • Published 5 years ago

@aquicore/aq-workflow v0.0.2

Weekly downloads
8
License
-
Repository
github
Last release
5 years ago

aq-workflow

get up and running 🏃‍

  1. click the 'use this template' button in github, name appropriately, clone locally.
  2. run:
node install.js $(basename `git rev-parse --show-toplevel`) && npm i && npm start

(i is shorthand for install)

  1. write your package code in src/js, tests go in src/js/test. Export public interfaces and classes from src/js/index.ts (this file acts as the main 'entry point' to the package and gives you full control over what is/is not exported publicly)
  2. commit your desired changes, code review if necessary
  3. publish the package by running npm run release. This will:
    • compile and bundle typescript
    • runs tests
    • version bump package.json and tag the commit with semver
    • ensure you publish from master with no uncommitted changes
    • publish to npm and create a github release (you should be logged in to the npm cli as aq-system, use npm whoami to check)

other

if you find a 🐛 bug in the template code, please fix it upstream! then everyone can share the goodness around.