docs: maintenance mode — what is taken, what is not planned, and why

README carries the status in both languages, CONTRIBUTING a 'Scope in
maintenance mode' section the triage bot links to, and ROADMAP a section
recording the decision: dependency, security, major-upgrade, defect and
wording work is taken; P1-7, X19, the engine caches and P2 are not
planned, each with its reason. The Audit backlog is the maintenance
backlog.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
poli0981andClaude Opus 5.5 committed 2026-11-21 23:22:12 +07:00
1 parent 61e5e26c4e
commit 39be719b22
3 files changed
+81 -10

No files matched your search

+36 -5
View File
@@ -6,6 +6,37 @@ one thing and proves it.
By taking part you agree to the [Code of Conduct](CODE_OF_CONDUCT.md).
## Scope in maintenance mode
**Since 1.6.0 (2026-11), PipDock is maintained rather than developed.** It does what it was
designed to do — the last missing core feature, adding an interpreter by path, shipped in 1.6.0 —
and from here the work is keeping it correct, safe and current. What that takes in:
- **Regular dependency updates** — Rust crates, npm packages, GitHub Actions and the Code Health
tool pins, the way Dependabot proposes them.
- **Security fixes** — a dependency with a High or Critical advisory, or a serious security problem
in a runtime or toolchain PipDock is built with (Node, Rust, WebView2), fixed promptly and
released when it reaches the shipped program.
- **Major language, runtime and framework upgrades** — Node 26 to 28, TypeScript 6 to 7, a Rust
edition, Tauri 2 to 3 — when they arrive and are stable.
- **Bugs, UI/UX defects and accessibility barriers** — anything that does not work as the docs
describe, gets in someone's way, or cannot be used with a keyboard, a screen reader or high
contrast.
- **Wording and translation** — English or Vietnamese text that is wrong, misspelt in a way that
changes the meaning, misleading, or does not read the way people actually speak. There is an
issue form for it.
**New features are not taken**, as issues or as pull requests. One that asks for a feature — titled
as a feature request, a `feat:` pull request, or labelled `enhancement` — is labelled
`out-of-scope` and closed automatically, with this section linked. That is not a judgement of the
idea. If you believe something is **truly necessary** — it fixes data loss, a security hole, or
makes the program unusable for someone without it — make the case in
[Discussions → Ideas](https://github.com/poli0981org/pipdock/discussions/categories/ideas); the
maintainer can keep an item open with the `policy-exception` label.
What is planned, and what was deliberately not built, is in [`docs/ROADMAP.md`](docs/ROADMAP.md)
under *Maintenance mode*.
## Before you write code
- **A bug** — [open an issue](https://github.com/poli0981org/pipdock/issues/new/choose). The in-app
@@ -13,11 +44,11 @@ By taking part you agree to the [Code of Conduct](CODE_OF_CONDUCT.md).
- **Something that gets in your way as a keyboard, screen-reader or high-contrast user** — see
[ACCESSIBILITY.md](ACCESSIBILITY.md). That report does not need a diagnosis.
- **A security problem** — do not open an issue; follow the [security policy](.github/SECURITY.md).
- **A question or an idea** — [Discussions](https://github.com/poli0981org/pipdock/discussions).
- **A feature** — please ask first. The design is written down in `docs/`, the feature list and its
non-goals are in [`docs/PRD.md`](docs/PRD.md), and what is planned and why is in
[`docs/ROADMAP.md`](docs/ROADMAP.md). A pull request that contradicts those will be asked to
change them first, and that is a conversation better had before the code.
- **Wrong or misleading text, in either language** — the *Wording or translation problem* form.
- **A question** — [Discussions](https://github.com/poli0981org/pipdock/discussions).
- **A feature** — not during maintenance; see [above](#scope-in-maintenance-mode). The design is
written down in `docs/`, and a fix that contradicts it will be asked to change the docs first,
which is a conversation better had before the code.
## Setting up
+6 -2
View File
@@ -10,6 +10,8 @@
> Repo: `poli0981org/pipdock` · License: **GPL-3.0-only** · Platform: **Windows 10/11** · Contact: [contact@poli0981.dev](mailto:contact@poli0981.dev) · [other channels](https://poli0981.dev/links/)
> **Status: maintenance mode, since 1.6.0.** PipDock is complete for what it set out to do, and is kept correct, safe and current rather than extended: dependency and security updates, major runtime upgrades, bug, UI/UX and accessibility fixes, and wording fixes in either language — no new features. [CONTRIBUTING.md](CONTRIBUTING.md#scope-in-maintenance-mode) says what is accepted. The repository moved from `poli0981/pipdock` to the **poli0981org** organization on 2026-11-21; the old address redirects.
---
## Why PipDock
@@ -50,7 +52,7 @@
| Area | What you get |
|---|---|
| Environments | Auto-discovery of installed Pythons — the Windows registry (PEP 514), the `py` launcher and the Pythons `uv python list` reports — plus a `.venv`, `venv`, `env` or `.env` folder in the folder PipDock was started from. Adding an environment by path is not in the app yet; the CLI takes any interpreter or environment folder with `--env` |
| Environments | Auto-discovery of installed Pythons — the Windows registry (PEP 514), the `py` launcher and the Pythons `uv python list` reports — plus a `.venv`, `venv`, `env` or `.env` folder in the folder PipDock was started from. **Add interpreter…** puts any other Python or virtual environment on the list (`pipdock env add` in the CLI), and *Remove from list* takes it off |
| PEP 668 guard | Pythons marked externally managed are refused by default. An override in Settings, off by default, asks before it turns on, and while it applies every screen that can change that Python says so |
| Installed | Full package list per env; up-to-date packages dimmed, outdated badged |
| Updates | Bulk update with group dry-run resolve, held-back explanations, 3-way conflict choices. The preview names every package *Force latest* would break, anything left out because it needs a different Python, and withdrawn (yanked) releases |
@@ -65,7 +67,7 @@
| pip upkeep | Check & update pip itself per environment |
| CLI | `pipdock` — full parity for core operations, JSON output, CI-friendly exit codes |
| Requirements | Export an environment as `requirements.txt`; import one and preview what it would install, with every line it will not use reported by number |
| Disk usage | Everything PipDock writes is under `%LOCALAPPDATA%\PipDock\data\`. Settings shows it and clears the parts that are safe to clear — snapshots (`snapshots\`), the Code Health tools environment (`tools\`) and the Security tab's audit environment (`audit\`). `index.db` (package index, settings, pins, your acceptance of the legal documents) is shown but never cleared; the logs (`logs\`) are deleted automatically after 14 days |
| Disk usage | Everything PipDock writes is under `%LOCALAPPDATA%\PipDock\data\`. Settings shows it and clears the parts that are safe to clear — snapshots (`snapshots\`), the Code Health tools environment (`tools\`) and the Security tab's audit environment (`audit\`). `index.db` (package index, settings, pins, the interpreters you added, your acceptance of the legal documents) is shown but never cleared; the logs (`logs\`) are deleted automatically after 14 days |
| Logs | PipDock keeps its own log, one file per day in `data\logs\`, and never sends it anywhere. It records the commands PipDock ran, so it holds package names and file paths. Settings shows the folder and copies the recent lines for a bug report |
| Keyboard | `Ctrl+K` command palette, `Ctrl+1`–`Ctrl+9` tabs (by key position, so AZERTY and other layouts work too), `/` for Search, full keyboard traversal |
| i18n | English + Tiếng Việt, remembered across restarts |
@@ -178,4 +180,6 @@ PipDock is an independent project. It is not affiliated with or endorsed by the
PipDock là ứng dụng Windows (GUI + CLI) giúp kiểm tra, cài đặt, cập nhật và gỡ **hàng loạt** gói thư viện Python một cách an toàn: luôn chạy dry-run xem trước thay đổi, xử lý xung đột phiên bản với 3 lựa chọn rõ ràng, tự chụp snapshot trước mỗi lần chạy để rollback một chạm, cảnh báo khi gỡ gói mà gói khác đang phụ thuộc, và tổng kết "13 thành công, 2 thất bại" kèm lý do từng gói. Hỗ trợ engine pip hoặc uv (chọn trong Settings), tìm gói tức thì nhờ cache chỉ mục PyPI, kèm module Code Health (deptry/vulture/ruff) để dọn dependency thừa và dead code. Không thu thập dữ liệu. Giấy phép GPL-3.0.
**Trạng thái: giai đoạn bảo trì, từ bản 1.6.0.** PipDock đã làm đủ những gì nó đặt ra, và từ nay được giữ cho đúng, an toàn và cập nhật chứ không mở rộng thêm: cập nhật phụ thuộc định kỳ, sửa lỗi bảo mật (CVE mức High trở lên hoặc lỗi nghiêm trọng của runtime), nâng cấp lớn ngôn ngữ/runtime/framework, sửa lỗi, lỗi UI/UX và rào cản tiếp cận, sửa câu chữ hoặc bản dịch dễ gây hiểu nhầm — **không nhận tính năng mới**; issue hay PR đề xuất tính năng sẽ tự động được gắn nhãn và đóng. Repo đã chuyển từ `poli0981/pipdock` sang tổ chức **poli0981org** ngày 2026-11-21; địa chỉ cũ vẫn tự chuyển hướng. Chi tiết trong [CONTRIBUTING.md](CONTRIBUTING.md#scope-in-maintenance-mode).
**Khả năng tiếp cận:** PipDock dùng được chỉ với bàn phím, với trình đọc màn hình (đã thử với Narrator) và ở chế độ tương phản cao của Windows. Chi tiết, kể cả những gì chưa được kiểm thử, nằm trong [ACCESSIBILITY.md](ACCESSIBILITY.md). Nếu gặp rào cản, hãy [mở issue](https://github.com/poli0981org/pipdock/issues/new?template=accessibility.yml) hoặc viết tới [accessibility@poli0981.dev](mailto:accessibility@poli0981.dev) — tiếng Việt cũng được.
+39 -3
View File
@@ -740,7 +740,7 @@ Three things it settled that outlive it:
## Post-1.0 (P1 wave)
Security tab (pip-audit), pin auto-suggest, requirements/constraints export-import, cache manager, command palette, dependency graph view, scheduled check. **Six of the seven have shipped** — four in 1.1.0, the Security tab in 1.2.0 and the dependency view in 1.3.0; the scheduled check remains. Then P2 candidates by demand: macOS/Linux, per-env engine, elevation broker, winget, JP locale.
Security tab (pip-audit), pin auto-suggest, requirements/constraints export-import, cache manager, command palette, dependency graph view, scheduled check. **Six of the seven have shipped** — four in 1.1.0, the Security tab in 1.2.0 and the dependency view in 1.3.0; the scheduled check is **not planned**, decided with the move to maintenance mode in 1.6.0 (*Maintenance mode*, below). Then P2 candidates by demand: macOS/Linux, per-env engine, elevation broker, winget, JP locale.
**About shipped early, in Phase 4** — see above. Two smaller items were added to this wave rather
than done at 1.0:
@@ -959,8 +959,9 @@ mode that is *silent*, and the reason SECURITY §4 requires the widening in pros
has always said audit never applies anything; "update to fixed version" is the ordinary Update flow,
reached by the user.
**What is left of Post-1.0 is one item**: the scheduled check (PRD P1-7). The dependency view
shipped as 1.3.0; its record is below.
**Nothing is left of Post-1.0.** The scheduled check (PRD P1-7) was the last item, and on
2026-11-21 the owner closed it as not planned, for the reasons the survey below gives; the
dependency view shipped as 1.3.0, and its record is below.
*This paragraph used to point at "the analysis above" for what blocked each of two items. There was
no such analysis anywhere in this document* — the survey existed only outside the repository, and
@@ -1687,6 +1688,41 @@ Tauri's configuration all assume the root now. And `pr-mode` is off in `qodana.y
had put it back on: a whole scan is two to three minutes a part, so analysing only a pull
request's files would save little and make a result depend on which files changed.
## Maintenance mode — from 1.6.0
**PipDock is maintained rather than developed from 1.6.0 on** (owner decision, 2026-11-21, with the
move to the poli0981org organization). 1.6.0 closed the last P0 gap, *Browse…*; nothing else on
this page will be built unless it qualifies below. CONTRIBUTING.md, "Scope in maintenance mode",
is the public version of this section, and `.github/workflows/triage.yml` enforces its edge.
**What the work is now:**
| Kind | What qualifies |
|---|---|
| Dependencies | Dependabot's weekly proposals, past their cooldowns, one PR superseding the bot's (the 2026-11-04 shape) |
| Security | A dependency advisory of High or Critical, or a serious security problem in a runtime or toolchain the program is built with (Node, Rust, WebView2) — fixed promptly, and released when it reaches the shipped binary |
| Majors | Language, runtime and framework upgrades — Node, TypeScript, a Rust edition, Tauri — once stable. The held-back i18next 27 + react-i18next 18 pair is the next one, and wants a session of its own |
| Defects | Bugs, UI/UX problems and accessibility barriers. **The Audit backlog above is this list**: every row that is a defect is in scope, every row that is a feature (X19, the engine caches) is not |
| Wording | English or Vietnamese that is wrong, misleading, or not how people speak; `.github/ISSUE_TEMPLATE/wording.yml` |
**What is not planned, and why** — each one decided, not dropped:
| Item | Why not |
|---|---|
| P1-7, the scheduled check | Every prerequisite is absent (the survey above), and its persona is served by the CLI in Task Scheduler. One plugin and a permanent background process for one line of text |
| P0-9's first-run uv detection (backlog X19) | Settings already shows both engines and their versions and switches with one click; a first-run prompt is a new surface, not a fix |
| P1-4's engine caches (`pip cache`, `uv cache`) | A different feature wearing the same word (P1 wave, above) |
| P2 — macOS/Linux, per-env engine, elevation broker, conda, portable mode, a Japanese locale | Each is a feature, and most a test matrix |
| Generating THIRD-PARTY-NOTICES | The licence checks (`cargo deny`, `npm licences`) now hold the claim the inventory makes; the inventory itself stays hand-kept |
| Retaking `screenshot/` | The owner's hands, when something visible changes enough to mislead |
**How the edge is held.** A feature request — titled as one, a `feat:` pull request, or labelled
`enhancement` — is labelled `out-of-scope` and closed by `triage.yml` with a bilingual answer that
links CONTRIBUTING. Only unmistakable signals count, because closing a real bug report would be
worse than leaving a request open; maintainers, bots and anything labelled `policy-exception` are
never closed. `workflow_dispatch` on it is a dry run that classifies a title without touching
anything.
## Standing risks
| Risk | Mitigation |