mirror of https://github.com/logos-co/logos-basecamp.git synced 2026-08-27 14:51:07 +00:00

Files

T

Dario Gabriel Lipicar 9b8cf6e47e feat(shell): ship main_ui as a plugin that links no logos runtime

Measured on the built artefact: main_ui.dylib DEFINES zero and IMPORTS zero of
TokenManager, StoreRegistry, LogosAPI, LogosAPIClient and logos_core_*, out of
3410 symbols read. It links Qt and nothing else from this workspace, which
nix/symbol-gate.nix enforces across the in-process image set.

Getting there needed the last non-Qt types off the boundary: the model
properties cross as QAbstractItemModel*, catalogInstallStageChanged carries an
int rather than InstallStage::Value, and the two prebuilt AppsFilterProxy
instances are declared in QML instead of owned by MainUIBackend. That last one
removes a real inversion -- PackageCoordinator called setRequiredPackages() on
a proxy the host held a pointer to; it now emits requiredPackagesResolved() and
QML binds to the republished property.

Window resolves the plugin, qobject_casts it to IShellView, checks
hostAbiVersion() against IShellHost_abi, and calls createShell(IShellHost*).
No error-label fallback widget: that degraded to something that looked like a
working app with an empty window.

Filter proxies read role constants off host-side models and InstallEnums is
used by nine host files, so app/interfaces/ gains the contract headers both
sides compile against -- the models inherit the role structs, leaving every
AppsModel::NameRole call site unchanged. The plugin's include path is
app/interfaces only, so including a host header does not compile.

Four things only running it finds:
  * Logos::DesignSystem may be linked by exactly ONE image -- both linked it
    and the app aborted with "Cannot add multiple registrations for
    Logos.Icons"; QML module registration is process-global
  * qmltyperegistrar emits no #include for a SOURCES header given as an
    absolute path outside the project
  * each qt_add_qml_module is its own target and inherits no include dirs
  * AUTOMOC pairs header<->cpp by same-basename-same-DIRECTORY, which the
    split breaks

tst_AppManagerView.qml grows five tests for the QML binding, checked with a
negative control: breaking one assertion fails qml-tests, so they run.

2026-08-22 16:42:13 -03:00

4.7 KiB

Raw Permalink Blame History

Contributing to Logos Basecamp

Thanks for wanting to contribute. This guide covers the mechanics — branch naming, build/test flow, PR expectations — so your change lands cleanly.

Before you start

Bug fixes: open (or find) a GitHub issue first if the bug isn't obvious. Small typo/formatting PRs can skip this.
New features: open an issue with the feature template first. We'd rather discuss shape before you invest implementation time.
Security issues: do NOT open a public issue. Use GitHub Private Vulnerability Reporting.

Branch naming

Prefix branches so the intent is legible at a glance and CI/label automation can key off them:

fix/<short-slug> — bug fix
feat/<short-slug> — new capability
chore/<short-slug> — dependency bumps, housekeeping
docs/<short-slug> — docs-only
test/<short-slug> — test-only
ci/<short-slug> — workflow / build-plumbing

Match the prefixes used on master — see git log --oneline for examples.

Commit messages

One purpose per commit. If your PR does two unrelated things, split it.
Subject line: <type>: <imperative summary> (mirroring branch prefixes: fix:, feat:, chore:, etc.).
Body: wrap at ~72 cols. Explain the why; the diff shows the what.
Reference issues in the body (Refs #123, Closes #456).

Building and testing

All builds go through Nix — do not run cmake directly.

nix build .#app                    # local (non-portable) dev build
./result/bin/LogosBasecamp

nix build .#smoke-test -L          # validates the app starts without QML errors
nix build .#integration-test -L    # end-to-end UI tests (hermetic, CI-safe)
nix build .#host-services-test -L  # capability trust root actually works (see below)
nix build .#doctests -L            # C++ doctests

host-services-test is the guard on the capability trust root: it asserts that a NON-core identity (ui-host, running package_manager_ui) actually completes a token-gated call chain, which is only possible when capability_module really received its token_registry / token_delivery host-services grant from the module loader this build pins. Run it after touching any of logos-liblogos, logos-module-loader-qt, logos-protocol, logos-plugin-qt or logos-capability-module pins — a loader that predates the grant makes capability_module fail closed, and every other check stays green.

Portable release-shaped builds:

nix build .#bin-bundle-dir         # directory bundle (Linux + macOS)
nix build .#bin-appimage           # Linux AppImage
nix build .#bin-macos-app          # macOS .app bundle

Iterating on QML without rebuilding

Point DEV_QML_PATH at the source tree — the three top-level view entries are read from disk. See CLAUDE.md for the covered entries and their limits.

Before you open a PR

Rebase (don't merge) master into your branch — keep history linear.
nix build .#smoke-test -L passes locally.
For UI changes, nix build .#integration-test -L passes and you've attached a screenshot/recording.
No unrelated files (.DS_Store, editor temp files, generated result symlinks, screenshots).
README.md / CLAUDE.md / docs/ updated if behaviour or build steps changed.

PR review flow

Open the PR against master using the template.
GitHub auto-assigns reviewers via CODEOWNERS.
CI (build.yml, doctests.yml) must pass — smoke + integration tests on Linux (x86 + ARM) and macOS.
At least one CODEOWNERS approval is required.
Squash-merge is the default; use merge-commit only for multi-commit PRs where each commit is meaningful on its own.

Release cadence

Releases are cut from release/** branches by the maintainers — see docs/RELEASE.md. If your fix needs to ship in the current release, mention that in the PR description and tag @Khushboo-dev-cpp.

Style and conventions

C++: C++17. No formatter enforced yet (.clang-format planned) — match the style of files you touch.
QML: Feature-axis qt_add_qml_module modules under src/Basecamp/<Feature>/. Follow the pattern: view files under a feature emit signals; backend calls belong in Basecamp/Shell/ContentViews.qml. See CLAUDE.md for the C++ backend split (MainUIBackend / CoreModuleManager / UIPluginManager / PackageCoordinator) — respect the dependency direction.
Nix: modular files under nix/. flake.nix inputs follow logos-cpp-sdk's nixpkgs — never pin a separate one.

Licensing

By contributing, you agree that your contribution is dual-licensed under Apache 2.0 and MIT, matching the repo license.

4.7 KiB Raw Permalink Blame History