Loading search…

Explain with AI
Edit this page

Reporting

Last updated

Where each kind of report goes — questions, bugs, features, and the private security advisory flow.

On this page

Read the troubleshooting page before filing. Many “bugs” are config, rate limits, or a site that blocked the scrape.

Routing

Topic Where
“How do I…” setup/usage questions Troubleshooting page
Ideas / feature requests Feature request template
New site requests Site request template
Bugs Bug report template
Security vulnerabilities Private security advisory — never public

Issues can only be filed with the templates (blank_issues_enabled is false). Bug reports are pre-labeled bug needs-triage; everything starts as needs-triage until a maintainer reproduces it.

Filing a bug report

The bug template asks for: description; exact command and output; affected URL (personal data scrubbed); platform; install method (prebuilt / pip / uvx / source); and debug output:

comic-dl self version
comic-dl -vvv -u "<URL>" 2>&1 | tail -50

Two things make every report land:

  • Sanitize before pasting — URLs can carry cookies or tokens.
  • Avoid real works — use synthetic slugs. This is a legal constraint, not style: see the project’s legal notes.

When not to file

  • A single site is down or slow — check open issues first.
  • 403 on a gallery — the troubleshooting page has a decision tree; report only if it didn’t help.
  • A security concern that is explicitly out of scope (third-party-site behavior, rate limits) — see security testing.

Feature requests

Open a feature request directly: say what you cannot do today, what you propose, and what you tried instead. For a new site, use the site request template, which asks for the domain, example pages, and whether an account is needed. A request without the details its template asks for is not actionable and usually gets closed. That is intentional — the scraper set is curated.

Security reports

Use the private advisory flow with coordinated disclosure — nothing public until a fix lands:

  • Report via Security → Report a vulnerability.
  • Include version/commit, reproduction steps, and impact. Timelines (from SECURITY.md): acknowledgement within 3 business days, assessment within 5, Critical/High fix as a patch release within 7 days of confirmation; Medium/Low ship in the next planned release.
  • Out of scope (per SECURITY.md): availability/rate-limit behavior from batched downloads, absence of credentials (the project stores none), behavior of third-party sites themselves.

After you file

Every issue carries needs-triage until reproduced. A duplicate close merges your info into the older issue; a wontfix close is deliberately out of scope — reopen only if new facts change that.