Contributing

@exile-watch/writ setup & contribution guide

exile.watch logo

Prerequisites

Development

1. Fork @exile-watch/writ 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 writ package locally in crucible project

a) Create writ package link

# @exile-watch/writ project
# package path e.g. ~/writ/packages/writ-react
$: npm link

b) Build writ package

# @exile-watch/writ project
# package path e.g. ~/writ/packages/writ-react
$: npm run build

c) Link writ package in crucible project

# @exile-watch/crucible project
# root path ~/crucible
$: npm link @exile-watch/writ-react #

6. Conclusion

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

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

# @exile-watch/writ project
# package path e.g. ~/writ/packages/writ-react
$: npm unlink

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