@ask-utils/game
v0.2.1
Published
Simply game helpers for ask-utils
Downloads
4
Readme
@ask-utils/game
GitHub Template repository to create a npm package by using TypeScript.
Badges
Prepare
$ git clone [email protected]:ask-utils/game.git
$ cd game
// Put your GitHub Personal Access Token
$ mv .envrc.example .envrc
$ vim .envrc
export CONVENTIONAL_GITHUB_RELEASER_TOKEN=PUT_YOUR_GITHUB_ACCESS_TOKEN
// Install
$ yarn
or
$ npm install
GitHub Personal Access Token Scope
If the project is private -> repo
If the project is public -> public_repo
Commit message rule
The repository runs commitlint. We have to follow "Conventional Commit" to make a commit message.
https://www.conventionalcommits.org/en/v1.0.0-beta.4/
$ git commit -m "<type>[optional scope]: <description>
[optional body]
[optional footer]"
Contribution
// clone
$ git clone [email protected]:ask-utils/game.git
$ cd game
// setup
$ yarn
// Unit test
$ yarn test
or
$ yarn run test:watch
// Lint
$ yarn run lint
or
$ yarn run lint --fix
// Build
$ yarn run build
// Rebuild docs
$ yarn run doc