Merge pull request #260 from poli0981/chore/maintenance-mode

chore(repo): enter maintenance mode — policy, auto-triage, issue forms, badges
This commit is contained in:
poli0981 authored and GitHub committed 2026-11-17 11:00:44 +07:00
commit 42697ce842
16 files changed
+412 -79

No files matched your search

+1 -1
View File
@@ -1,7 +1,7 @@
name: Accessibility barrier
description: Something stops or slows you down when you use a keyboard, a screen reader, zoom, high contrast, voice control or a touch screen.
title: "[A11y]: "
labels: ["accessibility", "triage"]
labels: ["accessibility", "needs-triage"]
body:
- type: markdown
attributes:
+1 -1
View File
@@ -1,7 +1,7 @@
name: Bug report
description: Something is broken or behaving unexpectedly.
title: "[Bug]: "
labels: ["bug", "triage"]
labels: ["bug", "needs-triage"]
body:
- type: markdown
attributes:
+4 -1
View File
@@ -1,5 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Feature ideas (maintenance mode)
url: https://github.com/poli0981/youtube-generator/discussions/categories/ideas
about: YTDescGen is in maintenance mode and takes no new features. Share ideas in Discussions, with no commitment. To add or remove an option in one of the app's lists, use the Option request form.
- name: Report a security vulnerability
url: https://github.com/poli0981/youtube-generator/security/advisories/new
about: Privately, please — never in a public issue. See SECURITY.md.
@@ -8,7 +11,7 @@ contact_links:
about: How-tos, backup & restore, troubleshooting and the FAQ.
- name: Discord
url: https://discord.gg/kDM9GMu5vm
about: For casual questions, gameplay chat, or quick help. Use a bug report or feature request for anything actionable.
about: For casual questions, gameplay chat, or quick help. Use an issue form for anything actionable.
- name: All channels and contacts
url: https://poli0981.dev/links/
about: Email addresses by purpose and every other way to reach the maintainer.
@@ -1,56 +0,0 @@
name: Feature request
description: Suggest a new feature or improvement.
title: "[Feature]: "
labels: ["enhancement", "triage"]
body:
- type: textarea
id: problem
attributes:
label: Problem
description: What pain point or workflow gap are you running into today?
validations:
required: true
- type: textarea
id: proposal
attributes:
label: Proposed solution
description: What should YTDescGen do? Be concrete — UI sketch, example output, etc.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: Other approaches you thought about and why you ruled them out.
- type: dropdown
id: scope
attributes:
label: Scope
description: Which surfaces does this affect?
multiple: true
options:
- Editor
- Output / preview
- Batch
- Social captions
- Playlist
- History
- Profiles / presets
- Templates (description, title, tags)
- Backup & restore
- i18n / locales
- Settings
- Accessibility (keyboard, screen readers, zoom, contrast)
- Web app (ytgenerator.stream)
- Desktop (Tauri)
- Android
- Documentation
validations:
required: true
- type: checkboxes
id: checks
attributes:
label: Pre-flight checks
options:
- label: I searched existing issues and this is not a duplicate.
required: true
+62
View File
@@ -0,0 +1,62 @@
name: Option request
description: Add or remove an option in one of the app's lists — a store, platform, genre, video type, content warning, tech note, GPU or upscaler / frame-generation mode.
title: "[Option]: "
labels: ["option-request", "needs-triage"]
body:
- type: markdown
attributes:
value: |
YTDescGen is in **maintenance mode** ([CONTRIBUTING.md → Maintenance mode](https://github.com/poli0981/youtube-generator/blob/main/CONTRIBUTING.md#maintenance-mode)): it takes no new features, but an option people really need can still join — or leave — one of the lists the app already has. For anything else, share the idea in [Discussions → Ideas](https://github.com/poli0981/youtube-generator/discussions/categories/ideas).
- type: dropdown
id: action
attributes:
label: Add or remove?
options:
- Add an option
- Remove an option
validations:
required: true
- type: dropdown
id: list
attributes:
label: Which list
options:
- Store (store links)
- Social or donate platform
- Game genre
- Video type
- Content warning
- Tech note
- GPU (rig catalog)
- Upscaler / frame generation (Video settings)
- Another list (say which below)
validations:
required: true
- type: input
id: option
attributes:
label: The option
description: Its name as it should appear, e.g. "itch.io", "Roguelite", "AMD FSR 4 x4".
validations:
required: true
- type: textarea
id: why
attributes:
label: Who needs it, and why
description: What can't you do today? A link helps — the store page, the vendor's announcement, a video of yours that needed it.
validations:
required: true
- type: textarea
id: wording
attributes:
label: Suggested wording (optional)
description: For a content warning or tech note, the editor label and the line the description should print, in any of the eight languages you know.
- type: checkboxes
id: checks
attributes:
label: Pre-flight checks
options:
- label: I searched existing issues and this is not a duplicate.
required: true
- label: This adds or removes an option in a list the app already has — it is not a new feature.
required: true
+69
View File
@@ -0,0 +1,69 @@
name: Translation or wording fix
description: Wording that doesn't fit a culture or region, or a spelling mistake that could mislead — in the interface or in the generated text.
title: "[i18n]: "
labels: ["i18n", "needs-triage"]
body:
- type: markdown
attributes:
value: |
YTDescGen ships eight languages. Vietnamese is native-reviewed; Japanese, Spanish, Korean, Chinese, Portuguese (Brazil) and Indonesian are AI-translated (see [DISCLAIMER.md](https://github.com/poli0981/youtube-generator/blob/main/DISCLAIMER.md)), so corrections from native speakers are very welcome.
- type: dropdown
id: language
attributes:
label: Language
options:
- English (en)
- Tiếng Việt (vi)
- 日本語 (ja)
- Español (es)
- 한국어 (ko)
- 简体中文 (zh)
- Português (BR) (pt-BR)
- Bahasa Indonesia (id)
validations:
required: true
- type: dropdown
id: where
attributes:
label: Where
options:
- The interface (buttons, labels, messages)
- The generated title, description or tags
- Both
validations:
required: true
- type: textarea
id: current
attributes:
label: Current text
description: Copy it exactly as shown, and say where you saw it — the page or field, or the section of the description. A screenshot helps.
validations:
required: true
- type: textarea
id: suggested
attributes:
label: Suggested text
validations:
required: true
- type: dropdown
id: why
attributes:
label: Why
options:
- It doesn't fit the culture, region or usual tone
- A spelling or grammar mistake that could mislead
- The meaning is wrong (a mistranslation)
- Something else (say below)
validations:
required: true
- type: textarea
id: details
attributes:
label: Details (optional)
- type: checkboxes
id: checks
attributes:
label: Pre-flight checks
options:
- label: I searched existing issues and this is not a duplicate.
required: true
+18
View File
@@ -1,3 +1,10 @@
<!--
YTDescGen is in maintenance mode (CONTRIBUTING.md → "Maintenance mode"):
new features are out of scope, and `feat:` pull requests from outside
contributors are closed automatically unless their scope is `options`
(an agreed option request), `a11y` or `i18n`.
-->
## Summary
<!-- 1-3 bullet points describing the change -->
@@ -5,6 +12,17 @@
-
-
## Scope
<!-- Tick what this PR is. Anything else is out of scope while YTDescGen is in maintenance mode. -->
- [ ] Bug fix, broken UI/UX or accessibility fix
- [ ] Translation or wording fix
- [ ] Add or remove an option in one of the app's lists, agreed in issue #
- [ ] Dependency update, security fix, or major language/runtime/framework upgrade
- [ ] Cloudflare / Worker change, or a fix for a website incident
- [ ] Docs or tests only
## Type
- [ ] `feat` — new feature
+107
View File
@@ -0,0 +1,107 @@
name: Maintenance triage
# YTDescGen is in maintenance mode (CONTRIBUTING.md → Maintenance mode). This
# workflow closes, with a bilingual comment and the `out-of-scope` label:
# • any issue or pull request the maintainer labels `out-of-scope`;
# • when opened by an outside contributor: issues titled [Feature…] or
# labelled `enhancement`, and pull requests titled `feat:` — except the
# scopes maintenance mode still takes: `options` (an agreed option
# request), `a11y` and `i18n`. The owner, members, collaborators and bots
# are skipped.
# pull_request_target runs in the base repository so it can comment on and
# close pull requests from forks. It never checks out or runs pull request
# code, and the script reads titles from the event payload itself instead of
# having untrusted text interpolated into it (.github/zizmor.yml says so too).
on:
issues:
types: [opened, labeled]
pull_request_target:
types: [opened, labeled]
permissions: {}
concurrency:
group: maintenance-triage-${{ github.event.issue.number || github.event.pull_request.number }}
cancel-in-progress: false
jobs:
triage:
name: Close out-of-scope requests
if: >-
(github.event.action == 'labeled' && github.event.label.name == 'out-of-scope') ||
(github.event.action == 'opened' &&
!contains(fromJSON('["OWNER","MEMBER","COLLABORATOR"]'),
github.event.issue.author_association || github.event.pull_request.author_association))
runs-on: ubuntu-latest
timeout-minutes: 5
permissions:
issues: write
pull-requests: write
steps:
- name: Close if out of scope
uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
with:
script: |
const OUT_OF_SCOPE = 'out-of-scope';
const TRUSTED = ['OWNER', 'MEMBER', 'COLLABORATOR'];
// Feature pull requests maintenance mode still takes.
const KEPT_SCOPES = ['options', 'a11y', 'i18n'];
const { payload } = context;
const isPR = Boolean(payload.pull_request);
const item = payload.pull_request ?? payload.issue;
if (!item || item.state !== 'open') return;
const labels = (item.labels ?? []).map((label) => label.name);
let reason = null;
if (payload.action === 'labeled') {
if (payload.label?.name === OUT_OF_SCOPE) reason = 'labelled out-of-scope';
} else if (payload.action === 'opened') {
const trusted = TRUSTED.includes(item.author_association);
const bot = item.user?.type === 'Bot';
const title = String(item.title ?? '').trim();
if (!trusted && !bot) {
if (isPR) {
// Conventional Commits: feat:, feat(scope):, feat!:
const feat = /^feat(?:\(([^)]*)\))?!?:/i.exec(title);
const scope = (feat?.[1] ?? '').trim().toLowerCase();
if (feat && !KEPT_SCOPES.includes(scope)) reason = 'feat: pull request';
} else if (/^\[feature/i.test(title) || labels.includes('enhancement')) {
reason = 'feature request';
}
}
}
if (!reason) {
core.info(`#${item.number}: within scope, nothing to do.`);
return;
}
const ideas = 'https://github.com/poli0981/youtube-generator/discussions/categories/ideas';
const policy = 'https://github.com/poli0981/youtube-generator/blob/main/CONTRIBUTING.md#maintenance-mode';
const en = isPR ? 'pull request' : 'issue';
const vi = isPR ? 'Pull request' : 'Issue';
const body = [
'<!-- maintenance-triage -->',
'Thanks for taking the time to write this. YTDescGen is in **maintenance mode**: it still takes dependency and security updates, major runtime upgrades, fixes for bugs, UI/UX, accessibility and translations, options added to or removed from its lists when people really need them, and Cloudflare or website fixes, but no new features.',
'',
`This ${en} falls outside that scope, so it has been closed. If it is actually a bug, an accessibility or translation fix, or an option request, reply here and the maintainer will take another look. Ideas are welcome in [Discussions → Ideas](${ideas}). The full policy is in [CONTRIBUTING.md → Maintenance mode](${policy}).`,
'',
'---',
'',
'Cảm ơn bạn đã dành thời gian. YTDescGen đang ở **giai đoạn bảo trì**: vẫn nhận cập nhật thư viện và bảo mật, nâng cấp runtime lớn, sửa lỗi, UI/UX, trợ năng (accessibility) và bản dịch, thêm hoặc bỏ một tuỳ chọn trong các danh sách của app khi thật sự có người cần, và sửa lỗi Cloudflare hay website, nhưng không thêm tính năng mới.',
'',
`${vi} này nằm ngoài phạm vi đó nên đã được đóng. Nếu thực ra đây là lỗi, sửa trợ năng hay bản dịch, hoặc yêu cầu tuỳ chọn, hãy trả lời tại đây để maintainer xem lại. Ý tưởng có thể gửi ở [Discussions → Ideas](${ideas}). Chính sách đầy đủ: [CONTRIBUTING.md → Maintenance mode](${policy}).`,
].join('\n');
const { owner, repo } = context.repo;
const number = item.number;
await github.rest.issues.createComment({ owner, repo, issue_number: number, body });
if (!labels.includes(OUT_OF_SCOPE)) {
await github.rest.issues.addLabels({ owner, repo, issue_number: number, labels: [OUT_OF_SCOPE] });
}
if (isPR) {
await github.rest.pulls.update({ owner, repo, pull_number: number, state: 'closed' });
} else {
await github.rest.issues.update({ owner, repo, issue_number: number, state: 'closed', state_reason: 'not_planned' });
}
core.notice(`Closed ${en} #${number} as out of scope (${reason}).`);
+6
View File
@@ -18,3 +18,9 @@ rules:
# actor) to the notifier script through `env:`, never by interpolation.
- notify-ci-failure.yml
- notify-release-pipeline.yml
# Runs on `pull_request_target` so it can label, comment on and close
# an out-of-scope pull request from a fork (maintenance mode). It never
# checks out the pull request, runs none of its code, and reads the
# title from the event payload inside the script — nothing from the
# pull request is interpolated into the workflow.
- maintenance-triage.yml
+11
View File
@@ -9,6 +9,17 @@
- **Repository**: `github.com/poli0981/youtube-generator` · **License**: Apache-2.0 (`LICENSE`, `NOTICE`, REUSE-compliant).
- **Maintainer**: poli0981 (SkullMute). Contacts by purpose: see `src/config/about.ts` and README.
**Status: maintenance mode** (since v1.6.0). Don't propose new features. Every change must fall under the policy in [`CONTRIBUTING.md` → Maintenance mode](CONTRIBUTING.md#maintenance-mode):
- dependency updates on the regular schedule;
- security fixes (a CVE rated high or critical, a serious runtime issue);
- major language, runtime or framework upgrades;
- bug, UI/UX and accessibility fixes, and adding or removing an option in one of the app's lists (stores, platforms, genres, video types, content warnings, tech notes, GPUs, upscaler / frame-gen modes) when people really need it;
- translation fixes (wording that doesn't fit a culture or region, misleading spelling);
- Cloudflare / Worker changes the platform forces, website incidents.
`.github/workflows/maintenance-triage.yml` closes out-of-scope issues and pull requests (label `out-of-scope`); `feat(options)`, `feat(a11y)` and `feat(i18n)` pull requests stay open.
## Tech Stack
| Layer | Technology |
+38 -4
View File
@@ -6,6 +6,28 @@ Thanks for taking the time to contribute. Read this once before opening your fir
Participation is governed by the [Code of Conduct](./CODE_OF_CONDUCT.md). By contributing, you agree to its terms.
## Maintenance mode
Since 1.6.0 (November 2026) YTDescGen is in **maintenance mode**. It is feature-complete and stays maintained, but it doesn't grow new features. These changes are still accepted:
1. **Dependency updates** on a regular schedule (weekly, grouped by Dependabot after a 7-day cooldown).
2. **Security fixes**, as soon as possible: a dependency with a high or critical CVE, or a serious security issue in a runtime such as Node.js.
3. **Major upgrades** of a language, runtime or framework, for example Node 24 → 26 or TypeScript 6 → 7.
4. **Issues and pull requests** that:
- add or remove an option in one of the app's lists when people really need it — a store, a social or donate platform, a genre, a video type, a content warning or tech note, a GPU, an upscaler or frame-generation mode (open an [option request](#option-requests) first);
- fix a bug, a broken UI/UX or an accessibility barrier.
5. **Language fixes**: wording that doesn't fit a culture or region, and spelling mistakes that could mislead (see [i18n Contributions](#i18n-contributions)).
6. **Cloudflare / Worker** changes when the platform changes significantly.
7. **Website incidents** such as DDoS or bot spam.
Anything else is out of scope, new features in particular, unless the maintainer judges one genuinely necessary.
- The [maintenance triage workflow](.github/workflows/maintenance-triage.yml) closes feature issues and `feat:` pull requests from outside contributors automatically — a `feat(options)`, `feat(a11y)` or `feat(i18n)` pull request stays open. It also closes anything the maintainer labels `out-of-scope`.
- Feature ideas are welcome in [Discussions → Ideas](https://github.com/poli0981/youtube-generator/discussions/categories/ideas), with no commitment.
- If your issue or pull request was closed by mistake, reply to it and the maintainer will take another look.
Releases ship only when one of these changes needs one, for example a security fix for the desktop and Android apps. The website keeps deploying from `main`.
## Getting Started
1. Read the [Development Guide](./docs/DEVELOPMENT.md) — also available in [Vietnamese](./docs/i18n/vi/DEVELOPMENT.md).
@@ -32,15 +54,25 @@ Participation is governed by the [Code of Conduct](./CODE_OF_CONDUCT.md). By con
Use the templates in `.github/ISSUE_TEMPLATE/`:
- **Bug report** — only if you can reproduce on the latest release.
- **Feature request** — only with a concrete use case, not abstract requests.
- **Option request** — add or remove an option in one of the app's lists; see [Option requests](#option-requests).
- **Translation or wording fix** — wording that doesn't fit a culture or region, or a spelling mistake that could mislead, in any of the eight languages.
- **Accessibility barrier** — anything that gets in the way with a keyboard, a screen reader, zoom, high contrast, voice control or touch. No reproduction on the latest release needed, and you don't need to know the cause. See [ACCESSIBILITY.md](./ACCESSIBILITY.md#reporting-a-barrier).
There is no feature request form any more: YTDescGen is in [maintenance mode](#maintenance-mode). Share ideas in [Discussions → Ideas](https://github.com/poli0981/youtube-generator/discussions/categories/ideas).
### Option requests
The one kind of addition maintenance mode still takes: an option in a list the app already has, when people really need it — a store (store links), a social or donate platform, a genre, a video type, a content warning or tech note, a GPU in the rig catalog, an upscaler or frame-generation mode. Removing one that no longer makes sense works the same way.
Open an **Option request** issue first: the option's name as it should appear, which list, and who needs it and why (a link to the store page, the vendor's announcement or a video that needed it helps). Once it's agreed, a pull request titled `feat(options): …` is welcome. [ARCHITECTURE.md → Extensibility Points](./docs/ARCHITECTURE.md) and CLAUDE.md's "Important Notes" say which files each kind of option touches, and the checks fail until all eight locales have its strings.
### Pull Requests
- Branch from `main` (`feat/…`, `fix/…`, `docs/…`) and open the PR against `main`. Every merge to `main` deploys the web app, so `main` stays releasable.
- Commit format and **PR title**: `type(scope): message` — e.g. `feat(engine): add Spanish template support`. Types: `feat`, `fix`, `refactor`, `docs`, `test`, `ci`, `chore`. CI checks the PR title.
- Required checks: `check`, `dependency-review`, `workflow-lint`, `reuse`, `pr-title`. When `src-tauri/` changes, the Rust workflow's `lint-and-test` and `cargo-deny` run too, and GitHub's CodeQL code scanning runs on every PR. SonarCloud analyses PRs opened from this repository — its quality gate wants A ratings, reviewed security hotspots, at most 3 % duplication and at least 80 % test coverage on new code in the layers Vitest measures (PRs from forks get no secrets and skip it; the maintainer's merge runs it on `main`). JetBrains Qodana does the same for TypeScript and for the Rust shell, and fails on any problem it finds. Commits on `main` are signed.
- PR titles start with a lower-case letter after the colon (`feat(editor): add …`, not `feat(editor): Add …`).
- In [maintenance mode](#maintenance-mode) a `feat` pull request from an outside contributor is closed automatically, unless its scope is `options`, `a11y` or `i18n`. A fix is a `fix`.
- One logical change per PR. Don't bundle unrelated refactors.
- All locale files must stay in lock-step — see the i18n section below.
- AI-assisted contributions are welcome but **must be disclosed** in the PR description.
@@ -74,15 +106,17 @@ The following are closed without review and may result in a contributor ban —
## What We Want
Within [maintenance mode](#maintenance-mode):
- Bug fixes with a reproduction case and a regression test.
- Locale corrections from native speakers.
- New content-warning or tech-note IDs with all 8 translations and a clear rationale (especially horror-genre vocabulary) — the checks fail until every locale has its label and description line.
- New video types or genres that fit the gameplay no-commentary use case.
- Accessibility and mobile-responsive improvements.
- An option people really need, agreed in an [option request](#option-requests) first — for example a content-warning or tech-note ID with all 8 translations and a clear rationale (especially horror-genre vocabulary), a store, a genre or a video type that fits the gameplay no-commentary use case.
- Accessibility and mobile-responsive fixes.
- Performance fixes with a `before/after` measurement.
## What We Don't Want
- New features, unless the maintainer judges one genuinely necessary — share the idea in [Discussions → Ideas](https://github.com/poli0981/youtube-generator/discussions/categories/ideas) instead.
- Cosmetic refactors with no behavior change.
- Adding new runtime dependencies without first opening an issue to discuss the tradeoff.
- Renaming files without coordinating with open PRs.
+10 -1
View File
@@ -1,5 +1,7 @@
# Maintainers
Since 1.6.0 the project is in **maintenance mode**: no new features, only the changes listed in [CONTRIBUTING.md → Maintenance mode](./CONTRIBUTING.md#maintenance-mode).
## Active Maintainers
### `@poli0981`
@@ -12,12 +14,19 @@
## Maintainer Responsibilities
- Triage incoming issues and PRs.
- Triage incoming issues and PRs, keeping them within the maintenance scope: the [triage workflow](./.github/workflows/maintenance-triage.yml) closes feature requests from outside contributors, and anything labelled `out-of-scope`, with an explanation.
- Run the release process: `CHANGELOG.md` entry, version bump, build artifacts, signed tag.
- Enforce the [Code of Conduct](./CODE_OF_CONDUCT.md).
- Review and approve locale translation contributions.
- Coordinate security advisory disclosure per [SECURITY.md](./SECURITY.md).
## Where to Reach Us
- Bug reports, translation fixes and option requests: [GitHub Issues](https://github.com/poli0981/youtube-generator/issues)
- Feature ideas, with no commitment while in maintenance mode: [Discussions → Ideas](https://github.com/poli0981/youtube-generator/discussions/categories/ideas)
- Accessibility barriers: the [Accessibility barrier](https://github.com/poli0981/youtube-generator/issues/new?template=accessibility.yml) form — see [ACCESSIBILITY.md](./ACCESSIBILITY.md)
- Vulnerabilities: privately, as [SECURITY.md](./SECURITY.md) describes
## Becoming a Maintainer
There is currently no formal pathway. The project has been solo since inception. If you'd like to help maintain a specific area — most realistically, native-speaker review for one of the AI-translated locales (JA / ES / KO / ZH / PT-BR / ID) — open an issue describing what you'd like to take on.
+18 -2
View File
@@ -6,6 +6,10 @@
Generate YouTube titles, descriptions and tags in eight languages. Save your channel as a profile and each game as a preset, and every new video is a few clicks.
[![Status: maintenance mode](https://img.shields.io/badge/status-maintenance_mode-yellow.svg)](#project-status)
[![CI](https://github.com/poli0981/youtube-generator/actions/workflows/ci.yml/badge.svg)](https://github.com/poli0981/youtube-generator/actions/workflows/ci.yml)
[![Qodana](https://github.com/poli0981/youtube-generator/actions/workflows/qodana.yml/badge.svg)](https://github.com/poli0981/youtube-generator/actions/workflows/qodana.yml)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=poli0981_youtube-generator&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=poli0981_youtube-generator)
[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](./LICENSE)
[![Node](https://img.shields.io/badge/node-%E2%89%A526-brightgreen)](./docs/DEVELOPMENT.md)
[![Latest release](https://img.shields.io/github/v/release/poli0981/youtube-generator?include_prereleases)](https://github.com/poli0981/youtube-generator/releases)
@@ -23,6 +27,18 @@ It doesn't talk to the YouTube API and has no account. Your work — profiles, p
Built for the gameplay no-commentary niche — especially horror / scary games — by someone running the [@SkullMute](https://www.youtube.com/@SkullMute) channel who got tired of pasting the same boilerplate into every video. Released under Apache 2.0 in case it's useful to anyone else.
## Project status
**Maintenance mode** since 1.6.0 (November 2026). YTDescGen is feature-complete, and it stays maintained:
- dependency updates on a regular schedule, and fast fixes for high or critical CVEs and serious runtime security issues;
- major language, runtime and framework upgrades (for example Node 24 → 26, TypeScript 6 → 7);
- bug, UI/UX and accessibility fixes, and adding or removing an option in one of the app's lists — a store, platform, genre, video type, content warning, GPU or upscaler mode — when people really need it;
- translation fixes: wording that doesn't fit a culture or region, and spelling mistakes that could mislead;
- changes the Cloudflare or Worker platform forces, and website incidents such as DDoS or bot spam.
New features are not planned, except the rare one that is genuinely necessary. Feature issues and pull requests outside this list are closed automatically. The full policy is in [CONTRIBUTING.md](./CONTRIBUTING.md#maintenance-mode).
## Features
- **20 video types** — Full Gameplay, Part, Boss Fight, Boss No-Hit, Ending, Speedrun, 100%, DLC, NG+, Challenge, Side Quest, Secret, Comparison, Guide, Mods, Collectibles, Livestream, Gacha Quest, Demo, Demo Part.
@@ -104,7 +120,7 @@ Architecture overview: [`docs/ARCHITECTURE.md`](./docs/ARCHITECTURE.md).
| [Architecture](./docs/ARCHITECTURE.md) | Layer model, data flow, engine design. |
| [Features](./docs/FEATURES.md) | Full feature matrix. |
| [Content Inventory](./docs/CONTENT-INVENTORY.md) | Every video type, genre, content warning and tech note the editor surfaces. _(Also: [Vietnamese](./docs/i18n/vi/CONTENT-INVENTORY.md).)_ |
| [Roadmap](./docs/ROADMAP.md) | What shipped and what's next. |
| [Roadmap](./docs/ROADMAP.md) | What shipped, and what maintenance mode still covers. |
| [Tech Spec](./docs/TECH-SPEC.md) | Implementation details and configs. |
| [i18n Guide](./docs/I18N.md) | Adding new locales. |
| [Packaging](./docs/PACKAGING.md) | Tauri desktop + Android release builds and signing. |
@@ -121,7 +137,7 @@ Architecture overview: [`docs/ARCHITECTURE.md`](./docs/ARCHITECTURE.md).
## Contributing
PRs welcome — read [CONTRIBUTING.md](./CONTRIBUTING.md) first. Native-speaker corrections to the AI-translated locales (JA / ES / KO / ZH / PT-BR / ID) are especially appreciated.
YTDescGen is in [maintenance mode](#project-status): bug, accessibility and translation fixes and agreed option requests are welcome — read [CONTRIBUTING.md](./CONTRIBUTING.md) first. Native-speaker corrections to the AI-translated locales (JA / ES / KO / ZH / PT-BR / ID) are especially appreciated. Feature ideas go to [Discussions → Ideas](https://github.com/poli0981/youtube-generator/discussions/categories/ideas).
## License
+2
View File
@@ -9,6 +9,8 @@ Only the latest released version of YTDescGen receives security updates, and the
| 1.5.x | ✅ |
| < 1.5 | ❌ |
YTDescGen has been in [maintenance mode](./CONTRIBUTING.md#maintenance-mode) since 1.6.0. That doesn't change this policy: security fixes keep shipping, and a dependency with a high or critical CVE is fixed as soon as possible.
## Reporting a Vulnerability
Please report security issues **privately**. Do not open a public issue.
+4 -1
View File
@@ -599,7 +599,10 @@ documents and ticks one "I agree" checkbox.
## 🔌 Future Extension Points
See [ROADMAP.md](./ROADMAP.md) for the post-1.0 backlog.
**Frozen: YTDescGen is in maintenance mode** (since v1.6.0) and takes no new
features — see [CONTRIBUTING.md → Maintenance mode](../CONTRIBUTING.md#maintenance-mode).
The ideas below and the [ROADMAP.md](./ROADMAP.md) backlog stay as a record; one
moves only if the maintainer judges it genuinely necessary.
| Extension | Description | Effort |
| -------------------- | ----------------------------------------------------------- | ------ |
+61 -12
View File
@@ -2,10 +2,12 @@
## YTDescGen — Phased Development Plan
> **Status (2026-11-10): v1.5.2 is the current release.** Phases 1–4 are the original
> plan, kept as a record; notes added beside or under an item say what has
> changed since. Every release is listed in [CHANGELOG.md](../CHANGELOG.md).
> What's next: Phase 5 and the backlog at the end of this page.
> **Status (2026-11-17): maintenance mode, from v1.6.0.** YTDescGen is
> feature-complete: it stays maintained but takes no new features — see
> [Maintenance mode](#maintenance-mode--from-v160) below. Phases 1–4 are the
> original plan, kept as a record; notes added beside or under an item say
> what has changed since. Every release is listed in
> [CHANGELOG.md](../CHANGELOG.md). Phase 5 and the backlog are frozen.
---
@@ -375,8 +377,54 @@ the initial load inside its budget —
---
## Maintenance mode — from v1.6.0
**Status**: ongoing since v1.6.0 (November 2026).
YTDescGen is feature-complete. From 1.6.0 on it is maintained, not extended:
no new features unless one is judged genuinely necessary. The accepted
changes, and how out-of-scope issues and pull requests are closed, are in
[CONTRIBUTING.md → Maintenance mode](../CONTRIBUTING.md#maintenance-mode):
1. Dependency updates on a regular schedule.
2. Security fixes: a dependency with a high or critical CVE, a serious runtime
issue.
3. Major language, runtime and framework upgrades (Node 24 → 26, TypeScript
6 → 7).
4. Bug, UI/UX and accessibility fixes, and adding or removing an option in one
of the app's lists when people really need it.
5. Translation fixes: wording that doesn't fit a culture or region, misleading
spelling mistakes.
6. Cloudflare / Worker changes the platform forces.
7. Website incidents such as DDoS or bot spam.
What 1.6.0 set up for it:
- [x] **Policy**: README → Project status, CONTRIBUTING → Maintenance mode,
SECURITY, MAINTAINERS, CLAUDE.md.
- [x] **Issue forms**: the feature request form is gone; an Option request
and a Translation or wording fix form joined Bug report and
Accessibility barrier; a Scope checklist in the pull request template.
- [x] **Auto-close**: `maintenance-triage.yml` closes, with a bilingual
comment and the `out-of-scope` label, feature issues and `feat:` pull
requests from outside contributors (`feat(options)`, `feat(a11y)` and
`feat(i18n)` stay open), and anything the maintainer labels
`out-of-scope`.
- [x] **Qodana**: Qodana for JS and Qodana for Rust (Early Access) on every
push and pull request, reported to Qodana Cloud, with a gate of zero
problems.
Known maintenance already queued: the GitHub Pages moving notice comes down
on 2026-11-29 (issue #177); i18next 27 and Tauri 3 arrive as planned major
upgrades when they are ready.
---
## Phase 5 — Extensions & Ecosystem (Priority: P2-P3)
**Frozen while YTDescGen is in maintenance mode.** An item moves only if it
falls under the [maintenance policy](../CONTRIBUTING.md#maintenance-mode).
**Goal**: IDE extension, CLI, community features.
**Estimated**: Ongoing
@@ -423,7 +471,8 @@ the initial load inside its budget —
## Backlog (after v1.0.0)
Ideas carried over from the v1.0.0 planning — not scheduled.
Ideas carried over from the v1.0.0 planning — not scheduled, and frozen while
YTDescGen is in maintenance mode.
```
- [ ] Auto-fill game info from Steam through the Worker — needs rate limiting
@@ -441,13 +490,13 @@ Ideas carried over from the v1.0.0 planning — not scheduled.
## Timeline Summary
| Phase | Scope | Days | Cumulative |
| ------- | ------------------ | ------- | ---------- |
| Phase 1 | MVP Core | 3-4 | 3-4 days |
| Phase 2 | Profiles & Presets | 2-3 | 5-7 days |
| Phase 3 | Polish & Advanced | 2-3 | 7-10 days |
| Phase 4 | Desktop App | 2-3 | 9-13 days |
| Phase 5 | Extensions | Ongoing | — |
| Phase | Scope | Days | Cumulative |
| ------- | ------------------ | ------ | ---------- |
| Phase 1 | MVP Core | 3-4 | 3-4 days |
| Phase 2 | Profiles & Presets | 2-3 | 5-7 days |
| Phase 3 | Polish & Advanced | 2-3 | 7-10 days |
| Phase 4 | Desktop App | 2-3 | 9-13 days |
| Phase 5 | Extensions | Frozen | — |
**MVP usable after Phase 1** (~3-4 days). Full-featured after Phase 3 (~7-10 days).
**v1.0.0 shipped on 2026-09-30; the current release is v1.5.2 (2026-11-10).**