Step-by-Step Instructions and Checklist

🌟 Enable private vulnerability reporting
Set up CodeCov
- Visit Codecov and set up your repo
- Create repository secret for CODECOV_TOKEN
Set up CodeClimate
- Visit CodeClimate and set up your repo
- Create [repository secret] for CC_TEST_REPORTER_ID
- Add *.test.* to ignore patterns on the website
- Update Code Climate badge
Add NPM_AUTH_TOKEN to repository secrets to automate package publishing
- Log in to your npm account and create an automation token
- Create a new repository secret NPM_AUTH_TOKEN
Update description in lib/package.json
(Optional) Add Repo Stats by visiting and setting up repobeats
Create your library and update examples
Update README as required
Set up GitHub pages to deploy docs
- Go to repo settings -> pages (On the left panel); Select deploy from a branch; Then Select main and /docs
(Optional) Set up Deepsource for static code analysis
Push your changes/Create PR and see your library being automatically tested and published
Optionally deploy your examples to Vercel.
Feel free to star this template, contribute, and/or sponsor the terborepo-template project or my other open-source work
You can also fork the terborepo-template and add your package to scripts/featured.json
- If approved, your package will be automatically added to FEATURED.md and also published on the home page of this repo.

Recommended Repository Settings

Go to [repository settings] and configure the following: