-
Notifications
You must be signed in to change notification settings - Fork 0
Conventions
github-actions[bot] edited this page Jun 10, 2026
·
2 revisions
The authoritative short versions live in the repo: CLAUDE.md (agent rules) and CONTRIBUTING.md (workflow). This page is the human-readable summary.
- Native Swift only: Swift, SwiftUI, AppKit, Apple system frameworks. Third-party dependencies require explicit maintainer approval — the default answer is no.
- macOS idioms: checkboxes (not switches), single
Windowscene, nativeTable/NavigationSplitView, menu bar integration. -
SWIFT_DEFAULT_ACTOR_ISOLATION = MainActor; pure logic types arenonisolated. - Every user-facing string goes through the String Catalog (English source, German translation).
- Editable lines round-trip byte-for-byte (
rendered == sourceLine). - Ambiguous lines are read-only — never rewritten, never deleted by the app.
- Every write: re-validate against disk → backup → atomic, symlink-safe, permission-preserving.
- Feature branches off
main(feat/…,fix/…,docs/…,ci/…); squash-merge PRs; PR title = Conventional Commit. - Conventional Commits enforced by the
commit-msghook and CI. - Versions are bumped by release-please only — never by hand.
- Every feature ships behind a flag registered in
FeatureFlags.swiftanddocs/FEATURE_FLAGS.md(CI-enforced). - User-visible changes update
docs/wiki/(EN + DE) in the same PR (CI-enforced; infrastructure-only PRs declareDocs: none).
- Swift Testing; parser/writer changes require test changes.
- No test ever touches real dotfiles or
$HOME.
Source of truth: docs/wiki/ in the main repo · edit via pull request · synced here automatically on merge.
📘 User Documentation
🔧 Technical (EN)