22 lines (15 loc) · 376 Bytes

Contributing

Thanks for contributing to Readie.

Local Setup

npm install
npm run build
npm run test

Workflow

Create a branch from main
Add or update tests for behavior changes
Run npm run test and npm run typecheck
Open a pull request with a clear summary

Reporting Issues

Open issues at: https://github.com/readie-cli/readie/issues