mirror of
https://github.com/got-feedBack/feedBack.git
synced 2026-09-13 08:29:28 +00:00
rename: slopsmith -> feedBack, byron -> got-feedBack
Renames across the entire codebase: - slopsmith/Slopsmith/SLOPSMITH/SlopSmith -> feedBack/FeedBack/FEEDBACK/FeedBack - byron/Byron/Byrongamatos -> got-feedBack/got-feedBack/got-feedBack - /home/byron/ -> /opt/got-feedBack/ - byron@ougsoft.com -> hi@got-feedBack.org - github.com/byrongamatos/ -> github.com/got-feedback/ - com.byron. -> com.got-feedback. - SLOPSMITH_ env vars -> FEEDBACK_ with backward-compat fallback - Protocol/storage strings migrated with read-old/write-new pattern - window.slopsmith JS API -> window.feedBack (canonical) + backward-compat alias Refs: #rename-slopsmith
This commit is contained in:
committed by
byrongamatos
parent
fdbab2a9e1
commit
d3037b903e
@@ -1,6 +1,6 @@
|
||||
# Slopsmith Constitution
|
||||
# FeedBack Constitution
|
||||
|
||||
> Slopsmith is a self-hosted, single-user web app for browsing, playing, and
|
||||
> FeedBack is a self-hosted, single-user web app for browsing, playing, and
|
||||
> practicing interactive music notation, built around its own open `.sloppak`
|
||||
> chart format (charts imported from Guitar Pro / MusicXML or authored in the
|
||||
> built-in editor). This constitution captures the non-negotiable principles
|
||||
@@ -13,7 +13,7 @@
|
||||
|
||||
### I. Self-Hosted, Single-User, Docker-First
|
||||
|
||||
Slopsmith targets one user running one container against a personal
|
||||
FeedBack targets one user running one container against a personal
|
||||
song library folder. There is no multi-tenant model, no
|
||||
authentication, no rate limiting, and no shared backend. Deployment is
|
||||
expressed as a single `docker compose up -d` against the bundled
|
||||
@@ -41,12 +41,12 @@ is Tailwind CSS, served as a prebuilt static stylesheet
|
||||
(`static/tailwind.min.css`, regenerated by `scripts/build-tailwind.sh`)
|
||||
— never the runtime Play CDN, whose on-the-fly JIT rescans the DOM on
|
||||
the main thread and caused sustained frame drops with the 3D highway
|
||||
(slopsmith-desktop#110). No React, Vue, Svelte, bundler, transpiler, or
|
||||
(feedBack-desktop#110). No React, Vue, Svelte, bundler, transpiler, or
|
||||
TypeScript appears in the core static tree, and no build step runs on
|
||||
the serve path: the Tailwind build is a maintainer-only one-shot whose
|
||||
output is committed, so Docker / desktop / end users never build. New
|
||||
features extend `app.js` and the existing globals (`window.playSong`,
|
||||
`window.showScreen`, `window.createHighway`, `window.slopsmith`).
|
||||
`window.showScreen`, `window.createHighway`, `window.feedBack`).
|
||||
|
||||
**Non-negotiable rules**
|
||||
|
||||
@@ -89,7 +89,7 @@ do not collide in `sys.modules`.
|
||||
sibling imports. Bare `import sibling` works during transition but
|
||||
triggers a startup warning when a name collides.
|
||||
- Plugins MUST register routes under `/api/plugins/<plugin_id>/...`,
|
||||
use `window.slopsmith.emit/on` for cross-plugin communication, and
|
||||
use `window.feedBack.emit/on` for cross-plugin communication, and
|
||||
prefix their `localStorage` keys with their plugin id.
|
||||
- Plugins inherit this constitution and may layer additional rules in
|
||||
their own `CLAUDE.md`, but MUST NOT relax core principles (e.g. a
|
||||
@@ -97,7 +97,7 @@ do not collide in `sys.modules`.
|
||||
|
||||
### IV. Backwards-Compatible Chart Library
|
||||
|
||||
The whole point of Slopsmith is that a user points it at an existing
|
||||
The whole point of FeedBack is that a user points it at an existing
|
||||
song library folder and it Just Works. The library is scanned and
|
||||
indexed in `meta.db` (SQLite via `MetadataDB`). The open Sloppak
|
||||
format (`lib/sloppak.py`; specified at
|
||||
@@ -145,7 +145,7 @@ push and PR to `main` against Python 3.12.
|
||||
All backend output goes through the stdlib `logging` pipeline configured
|
||||
by `lib/logging_setup.py`, controlled by `LOG_LEVEL` / `LOG_FORMAT` /
|
||||
`LOG_FILE`. Plugins receive a pre-configured `context["log"]` namespaced
|
||||
to `slopsmith.plugin.<id>` and MUST use it instead of `print`. HTTP
|
||||
to `feedBack.plugin.<id>` and MUST use it instead of `print`. HTTP
|
||||
responses carry a `X-Request-ID` header from `CorrelationIdMiddleware`
|
||||
and the same id appears as `request_id` in JSON log lines. The
|
||||
"Settings → Export Diagnostics" bundle (`lib/diagnostics_bundle.py`)
|
||||
@@ -171,7 +171,7 @@ User configuration lives in two places: server-side under `CONFIG_DIR`
|
||||
(SQLite `meta.db`, `config.yaml`, plugin opted-in files) and client-
|
||||
side in browser `localStorage`. Both can be exported and re-imported
|
||||
as a single bundle (`POST /api/settings/import`,
|
||||
`GET /api/settings/export`, slopsmith#113). Import is two-phase:
|
||||
`GET /api/settings/export`, feedBack#113). Import is two-phase:
|
||||
phase-1 validates the entire bundle (schema, paths, encoding) and
|
||||
phase-2 commits each file atomically via temp+rename. Plugins opt
|
||||
their server-side files into the bundle via
|
||||
@@ -188,7 +188,7 @@ no `..`, no absolute paths).
|
||||
Importing a bundle whose schema predates the running plugin's code
|
||||
MUST restore bytes verbatim — the plugin copes at next load.
|
||||
- The `VERSION` file is the single source of truth for the running
|
||||
release; it is auto-bumped from `slopsmith-desktop` releases via
|
||||
release; it is auto-bumped from `feedBack-desktop` releases via
|
||||
`.github/workflows/sync-version.yml`. Manual edits are reserved for
|
||||
out-of-band recovery only.
|
||||
|
||||
@@ -219,7 +219,7 @@ no `..`, no absolute paths).
|
||||
|
||||
- **Branching**: never push directly to `main`. Always feature branch
|
||||
+ PR. Exception: the automated `VERSION` bump from
|
||||
`slopsmith-desktop`'s release job, which commits to `main` as
|
||||
`feedBack-desktop`'s release job, which commits to `main` as
|
||||
`github-actions[bot]`.
|
||||
- **Reviews**: PRs run the local Codex review loop
|
||||
(`feedback_codex_preflight.md`) and the GitHub Copilot review pass
|
||||
|
||||
Reference in New Issue
Block a user