2025-06-29 14:03:13 +08:00
# Contributing to Basecoat
2025-06-29 14:04:49 +08:00
- Support development by sponsoring the author: https://github.com/sponsors/hunvreus
2025-06-29 14:03:13 +08:00
- Submit pull requests (PRs) against the `development` branch, not `main` .
- For branches, we have:
2026-06-27 08:55:48 +08:00
- `main` is our production and default branch. This is what we deploy to https://basecoatui.com and publish to https://www.npmjs.com/package/basecoat-css.
2025-06-29 14:03:13 +08:00
- `development` is for staging. We will deploy it soon at https://dev.basecoatui.com.
- New features are worked in `feature/name-of-the-feature` branches.
- Issues are addressed in `issue/123-main-isse` branches.
- When ready, we PR against `development` , test it and then finally merge to `main` .
- Keep changes focused: one feature or fix per PR.
- Test locally before submitting.
- Follow existing code style.
2026-06-03 18:59:21 +08:00
## Cloudflare Workers deploys
2026-06-27 18:07:58 +08:00
Docs are built with ReallySimpleDocs/Astro and deployed as Workers Static Assets from `site/dist` .
2026-06-03 18:59:21 +08:00
- Local preview: `npm run workers:dev`
- Production deploy: `npm run workers:deploy`
- Preview version upload: `npm run workers:preview`
Workers Builds settings:
- Build command: `npm run docs:build`
- Deploy command: `npx wrangler deploy`
- Non-production branch deploy command: `npx wrangler versions upload`
- Production branch: `main`
- Enable builds for non-production branches for branch preview URLs.
Thanks for helping!
