Files
youtube-generator/CONTRIBUTING.md
T
poli0981andClaude Opus 5.5 bca589e169 docs: v1.0.0 — changelog, README, contacts, hosting guide, CLAUDE.md; bump to 1.0.0
- CHANGELOG: the v1.0.0 entry (moving house, new interface, data fixes,
  backup & restore, faster entry, catalogs, desktop hardening, CI).
- README: the web app at ytgenerator.stream, what moved from GitHub
  Pages, current features, privacy as it is now (Cloudflare delivery,
  Turnstile, cookieless analytics on the web only), contacts by purpose;
  the dead Discord invite and the old email are gone.
- docs/HOSTING.md (new): Worker routing, cookies, headers, secrets,
  one-time dashboard settings, local dev, previews and rollback.
- CLAUDE.md rewritten for the real stack, layout, commands and rules.
- CONTRIBUTING / PR template / issue templates: main-only branching,
  the required checks, 8 locales, Android and current versions; issue
  links to security advisories, the wiki, Discord and poli0981.dev/links.
- DISCLAIMER (+ Vietnamese), NOTICE: current model disclosure and the
  copyright / DMCA contacts. PRIVACY: backup locations and the moving
  notice on the old address.
- Version 1.0.0 in package.json, package-lock.json, tauri.conf.json,
  Cargo.toml and Cargo.lock.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-30 23:06:01 +07:00

4.8 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

  1. Read the Development Guide — also available in Vietnamese.
  2. Install dependencies: npm install.
  3. Start the dev server: npm run dev.
  4. Before opening a PR, run the same gates CI runs (the required check job):
    npm run typecheck && npm run typecheck:all
    npm run lint && npm run format:check
    npm run validate:locales
    npm run test:run
    npm run knip
    npm run build && npm run check:bundle
    
    Touched src-tauri/? Also cargo fmt --check, cargo clippy --all-targets -- -D warnings and cargo test in src-tauri/. Touched worker/ or wrangler.jsonc? npm run cf:check dry-runs the Cloudflare deploy.

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 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 (plus lint-and-test and cargo-deny when src-tauri/ changes). Commits on main are signed.
  • 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:

  1. Update the locale schema at src/i18n/locales/_schema.json first.
  2. Add the key to all 8 locales (en / vi / ja / es / ko / zh / pt-BR / id).
  3. npm run validate:locales must 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 --no-verify used to bypass pre-commit hooks.
  • "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 IDs with all 8 translations and a clear rationale (especially horror-genre vocabulary).
  • New video types or genres that fit the gameplay no-commentary use case.
  • Accessibility and mobile-responsive improvements.
  • Performance fixes with a before/after measurement.

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.