|
| 1 | +# Forkara rebrand checklist (for downstream forks) |
| 2 | + |
| 3 | +Use this checklist when adapting Forkara for another fork name, logo, or distribution identity. |
| 4 | + |
| 5 | +## 1) Identify owned touchpoints |
| 6 | + |
| 7 | +- [ ] Confirm repository metadata and docs still point to your fork owner (e.g., support links, source links, issue links). |
| 8 | +- [ ] Confirm legal attributions are preserved and do not remove copyright notices without approval. |
| 9 | + |
| 10 | +## 2) App & packaging identity |
| 11 | + |
| 12 | +- [ ] Update product/binary identity values in [desktop identity](packages/shared/src/desktopIdentity.ts): |
| 13 | + - display names |
| 14 | + - bundle IDs |
| 15 | + - schemes/origins |
| 16 | + - default home/user-data directory names where appropriate for your fork. |
| 17 | +- [ ] Review executable/binary and updater naming references in: |
| 18 | + - `scripts/release-smoke.ts` |
| 19 | + - `scripts/release-update-policy.ts` |
| 20 | + - `scripts/build-desktop-artifact.ts` |
| 21 | + - `scripts/verify-packaged-desktop-startup.ts` |
| 22 | + - related release artifact tests in `scripts/*.test.ts`. |
| 23 | +- [ ] If you keep legacy manifest compatibility, keep release expectations aligned in `docs/release.md`. |
| 24 | + |
| 25 | +## 3) Package metadata |
| 26 | + |
| 27 | +- [ ] Update package names/scopes and homepage/repository fields in package manifests if your fork wants a distinct namespace. |
| 28 | +- [ ] Review `@synara/*` references in package manifests and CLI scripts for rename impact. |
| 29 | +- [ ] Keep `apps/server/package.json` binary names (`synara`, `synara-restore-migration-backup`) intentional; if changing them, update launch and smoke assumptions in code. |
| 30 | + |
| 31 | +## 4) Repo/runtime configuration |
| 32 | + |
| 33 | +- [ ] Review `SYNARA_*` home/binary naming assumptions in: |
| 34 | + - `packages/shared/src/synaraHome.ts` |
| 35 | + - `apps/desktop/src/main/process.ts` |
| 36 | + - `scripts/dev-runner.ts` |
| 37 | + - `scripts/canary.ts` |
| 38 | +- [ ] Check CLI and release docs for any hard-coded upstream/release names. |
| 39 | + |
| 40 | +## 5) Documentation touchpoints |
| 41 | + |
| 42 | +- [ ] Update README and `CONTRIBUTING.md` brand language and install/branding guidance. |
| 43 | +- [ ] Update support/supporting docs (`docs/external-mcp.md`, `docs/release.md`, workflow docs). |
| 44 | +- [ ] Add a fork-specific changelog note if the change is user-visible. |
| 45 | + |
| 46 | +## 6) Brand audit behavior |
| 47 | + |
| 48 | +- [ ] Decide whether `scripts/check-brand-identity.ts` should stay strict (current upstream-attribution guard) |
| 49 | + or be relaxed for your forking policy. |
| 50 | +- [ ] If relaxing, add/adjust approved attributions and regenerate any approved visual digests as needed. |
| 51 | + |
| 52 | +## 7) Validate before pushing |
| 53 | + |
| 54 | +- [ ] Smoke-check release metadata naming from `docs/release.md` and `scripts/release-smoke.ts`. |
| 55 | +- [ ] Update release notes/templates and any docs that mention old repo branding. |
| 56 | +- [ ] Run your normal rename/branding validation in CI for both PR and release paths. |
0 commit comments