Contributing (scripts)

@exile-watch/nucleus setup & contribution guide

exile.watch logo

Prerequisites

Development

1. Fork @exile-watch/nucleus repo

2. Create GitHub PAT token

3. Create .npmrc file

4. Install dependencies

# project root
$: nvm use # uses node version that's defined in .nvmrc
$: npm i # install dependencies

5. Check changes made in nucleus package locally in crucible project

a) Create nucleus package link

# @exile-watch/nucleus project
# package path e.g. ~/nucleus/packages/encounter-data
$: npm link

b) Build nucleus package

# @exile-watch/nucleus project
# package path e.g. ~/nucleus/packages/encounter-data
$: npm run build

c) Link nucleus package in crucible project

# @exile-watch/crucible project
# root path ~/crucible
$: npm link @exile-watch/encounter-data #

6. Conclusion

Not happy with the change? Repeat step b) Build nucleus package and c) Link nucleus package in crucible project

Happy with the change? Create a new pull request and don't forget to locally unlink modified package:

# @exile-watch/nucleus project
# package path e.g. ~/nucleus/packages/encounter-data
$: npm unlink

# @exile-watch/crucible project
# root path ~/crucible
$: npm i # this will "revert" linked module to the actual package