You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
Thanks for helping make `codex-ubuntu` better.
4
4
5
-
This project is still early, but it is not casual about launcher safety. Small-looking changes in runtime discovery, PID handling, or browser launch behavior can break trust fast, so please read the docs before editing core flows.
5
+
This project is still early, but it is not casual about desktop-launch safety. Small-looking changes in runtime discovery, PID handling, browser fallback behavior, or future Electron intake can break trust fast, so please read the docs before editing core flows.
6
6
7
7
## Before you open a pull request
8
8
@@ -35,6 +35,7 @@ make install-local
35
35
36
36
Good first contributions:
37
37
38
+
- Electron-first repo shaping
38
39
- launcher hardening
39
40
- test coverage improvements
40
41
- desktop integration polish
@@ -46,7 +47,7 @@ Changes that need extra care:
46
47
- process stop or reuse logic
47
48
- provider contract changes
48
49
- token handling or logging changes
49
-
- anything that touches auth, runtime metadata, or port ownership
50
+
- anything that touches auth, runtime metadata, port ownership, or desktop identity
Unofficial Ubuntu-first launcher and packaging projectfor Codex.
9
+
Unofficial Ubuntu-first Electron desktop project, with a browser fallback for recovery and constrained environments.
10
10
11
-
`codex-ubuntu` is trying to solve a very specific problem well: make the app feel at home on Ubuntu without pretending Linux support is already finished upstream, and without baking in fragile local assumptions that break as soon as the machine changes.
11
+
`codex-ubuntu` is trying to solve a very specific problem well: make the app feel genuinely at home on Ubuntu. The browser wrapper was useful as a safety exercise, but it is not the end state. The product target is now an Electron-first Ubuntu desktop experience, because that is the path that actually feels like a real app in daily use.
12
12
13
13
## Why this exists
14
14
15
-
Ubuntu users currently end up choosing between:
15
+
Ubuntu users usually end up choosing between:
16
16
17
17
- browser-first one-off launch scripts
18
18
- brittle personal-machine wrappers
19
19
- heavy unofficial ports with a large maintenance surface
20
20
21
-
This repository takes the narrower path:
21
+
This repository now takes the harder but more honest path:
22
22
23
-
- real Ubuntu launcher behavior
23
+
- Electron-first desktop direction
24
+
- browser launcher retained only as fallback and recovery
24
25
- explicit security rules around runtime ownership
25
26
-`.deb`-first packaging direction
26
-
-provider boundaries that leave room for future runtime strategies
27
+
-clear boundaries between desktop payload, compatibility patches, and fallback tooling
27
28
28
29
## What works today
29
30
30
-
The current repository is not just a design memo. It ships a working launcher foundation with:
31
+
The current repository is not just a design memo. It already ships:
31
32
32
-
- dedicated app-window flow
33
+
- a repo-owned local Electron launcher wrapper for dogfooding
34
+
- a minimum Electron payload intake workflow
35
+
- a strict browser fallback launcher
33
36
- XDG config, cache, and state handling
34
37
- verified process ownership before stop or reuse
35
38
- runtime and browser discovery without hardcoded personal paths
36
39
- local install flow
37
-
-`.deb` build path
40
+
- local Electron install flow
41
+
-`.deb` build path for the fallback utility
38
42
- smoke tests and CI
43
+
- Electron-first repo structure and migration docs
39
44
40
45
## What it is not claiming
41
46
42
47
This repository is not yet:
43
48
44
49
- an official Linux desktop release
45
-
- a full upstream desktop-payload repackager
50
+
- a self-contained Electron desktoppayload inside this repo
46
51
- a finished updater
47
52
- a promise to redistribute proprietary upstream app assets
48
53
49
-
The local repackager path is still exploratory, not a committed milestone.
54
+
The Electron direction is the main product path, but the exact asset and distribution model still has to stay explicit and careful.
50
55
51
56
## Current strategy
52
57
53
-
The recommended v1 is intentionally launcher-first.
58
+
The project is now Electron-first.
54
59
55
60
That means:
56
61
57
-
1. the Ubuntu launcher and desktop integration are real now
58
-
2. the browser-shell runtime path is implemented now
59
-
3. the provider contract is defined now
60
-
4.future runtime modes can be added without rewriting the project shape
62
+
1. the product target is an Ubuntu desktop app, not a dressed-up browser tab
63
+
2. the browser-shell path stays only as fallback and recovery mode
64
+
3. the provider contract still matters because both paths need safe runtime ownership rules
65
+
4.packaging remains `.deb`-first
61
66
62
67
### Runtime model
63
68
64
69
Implemented today:
65
70
66
-
-`browser-shell`
71
+
-`browser-shell` fallback
67
72
68
-
Planned but not implemented:
73
+
Primary target:
74
+
75
+
-`desktop-payload` (Electron-first)
76
+
77
+
Optional later:
69
78
70
79
-`app-server`
71
-
-`desktop-payload`
72
80
73
-
See [providers/contract.md](providers/contract.md), [providers/browser-shell.md](providers/browser-shell.md), and [docs/architecture.md](docs/architecture.md).
81
+
See [providers/contract.md](providers/contract.md), [providers/browser-shell.md](providers/browser-shell.md), [docs/architecture.md](docs/architecture.md), and [docs/electron-first-plan.md](docs/electron-first-plan.md).
This directory needs to serve both the future Electron desktop path and the current browser fallback utility without letting their app identities drift apart.
0 commit comments