Here are the ways to get involved with this project:
Before submitting your issue, make sure it has not been mentioned earlier. You can search through the existing issues or Github Discussions.
Found a bug you can fix? Fantastic! Patches are always welcome.
Follow the Quick Start guide to get the project up and running.
- Fork the repo and create a feature/patch branch off
main - Work locally adhering to coding standards
- Run
npm run lint - Make sure the app builds locally with
npm run build && npm run start - Push your code, open a PR, and fill out the PR template
- After peer review, the PR will be merged back into
main - Repeat ♻️
Your PR must pass automated assertions, deploy to Vercel successfully, and pass a peer review before it can be merged.
I've found that running vercel locally is a great way to verify Edge Functions and Middleware are working as expected.
To install the Vercel CLI, run:
npm i -g vercelStart a Vercel development server locally:
vercel devThis repo is maintained by Greg Rickaby. By contributing code you grant its use under the MIT.