Docs had drifted since 1.0.0: README missed the 1.1.0 features and showed an Android step that overwrites the committed Gradle project; ROADMAP, PACKAGING, ARCHITECTURE and TECH-SPEC still described 1.0.0; CONTRIBUTING and the PR template listed half the gates; SECURITY named 1.0.x; CLAUDE.md's structure and gate list were out of date. webapp/TAURI.md (Node 25, no .rpm) is folded into PACKAGING and removed. Also: purpose-word validation documented in ARCHITECTURE, two stale code comments (about.ts, vietnamese-banks.ts), .gitignore for the maintainer's local note files, and the CHANGELOG entry. Six manifests bumped 1.1.0 -> 1.2.0. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
5.4 KiB
Contributing to YTDescGen
Thanks for taking the time to contribute. Read this once before opening your first PR — it saves time on both sides.
Code of Conduct
Participation is governed by the Code of Conduct. By contributing, you agree to its terms.
Getting Started
- Read the Development Guide — also available in Vietnamese.
- Install dependencies:
npm install. - Start the dev server:
npm run dev. - Before opening a PR, run the same gates CI runs (the required
checkjob):npm run typecheck && npm run typecheck:all npm run lint && npm run format:check npm run validate:locales npm run test:coverage npm run knip npm run check:version && npm run check:tauri && npm run check:licenses npm run check:copyright npm run build && npm run check:bundle npm run cf:checkcheck:licensesfails whenTHIRD_PARTY_NOTICES.mdis stale —npm run generate:third-partyrewrites it.check:copyrightfails in the first commit of a new year —npm run update:copyrightfixes it. Touchedsrc-tauri/? Alsocargo fmt --check,cargo clippy --all-targets --locked -- -D warningsandcargo testinsrc-tauri/(afternpm run build— see the Development Guide).
How to Contribute
Issues
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.
Pull Requests
- Branch from
main(feat/…,fix/…,docs/…) and open the PR againstmain. Every merge tomaindeploys the web app, somainstays 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. Whensrc-tauri/changes, the Rust workflow'slint-and-testandcargo-denyrun too, and GitHub's CodeQL code scanning runs on every PR. Commits onmainare signed. - PR titles start with a lower-case letter after the colon (
feat(editor): add …, notfeat(editor): Add …). - 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.
i18n Contributions
If your change adds or removes any user-facing string:
- Update the locale schema at
src/i18n/locales/_schema.jsonfirst. - Add the key to all 8 locales (
en/vi/ja/es/ko/zh/pt-BR/id). npm run validate:localesmust pass.
Native-speaker corrections to AI-translated locales (JA / ES / KO / ZH / PT-BR / ID) are especially welcome — see DISCLAIMER.md for the current translation-quality status.
Auto-ignored Contributions
The following are closed without review and may result in a contributor ban — no exceptions:
- Suspected malicious code. If a PR contains code we suspect may be a supply-chain attack, obfuscation, credential harvesting, cryptominer, or any form of malware — even if CodeQL and Dependabot don't flag it, the maintainer may investigate manually. Detection equals ban.
- Unverified or suspicious links in issues, PRs, or comments (pastebin scrapers, redirect chains, unfamiliar shortlinks, link-shortener URLs without context).
- Behavior or language violating GitHub's Acceptable Use Policies.
- Off-topic / rambling reports that don't get to the point. Example of what gets ignored: "Good morning, today is a beautiful day, I was just wondering if maybe…" — get straight to the problem.
- PRs that touch hundreds of files for a one-line fix (typical sign of an auto-formatter run on unrelated files).
- Tests deleted or skipped to make CI pass.
- "AI rewrote my entire codebase in a different style" PRs. AI-assisted edits are welcome (disclosed); whole-repo rewrites are not.
- Spam, drive-by typo fixes that don't address a real issue, and karma-farming PRs.
What We Want
- 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.
- Performance fixes with a
before/aftermeasurement.
What We Don't Want
- 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.
- Changes to the LICENSE or NOTICE files (these are governance, not contributions).
Contact
Questions about contributing or conduct: code@poli0981.dev. Security issues go through SECURITY.md, never a public issue.
License
By contributing, you agree your contribution will be licensed under the Apache License 2.0, the same license as the project, and that you have the right to grant that license.