Contributing

@exile-watch/splinters setup & contribution guide

exile.watch logo

Prerequisites

Development

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

a) Create splinter package link

# @exile-watch/splinters project
# package path e.g. ~/splinters/packages/biome-config
$: npm link

b) Build splinters package

# @exile-watch/splinters project
# package path e.g. ~/splinters/packages/biome-config
$: npm run build

c) Link splinter package in crucible

# e.g. @exile-watch/crucible project
# root path ~/crucible
$: npm link @exile-watch/biome-config

6. Conclusion

Not happy with the changes? Repeat step b) Build splinters package and c) Link splinter package in crucible

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

# @exile-watch/splinters project
# package path e.g. ~/splinters/packages/biome-config
$: npm unlink

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