Skip to content

v2.0.1 — documentation and contributor onboarding

Choose a tag to compare

@LeyckerS LeyckerS released this 31 Jul 01:53
· 79 commits to main since this release
138cae6

No code changed in this release. This is documentation and contributor onboarding.

What's new

  • Scope and responsible use section in the README — what the tool does and
    does not do, who owns the copyright question, and a plain statement that the
    datanodes path automates an anti-bot challenge
  • Engineering highlights moved above the provider table — BrowserGate, the
    pull-model UI, the cursored log ring, the single clamping boundary
  • CI and stars badges
  • CONTRIBUTING.md now has a Where to start section
  • Screenshots redacted

Contributors

This release exists because of work from outside the maintainer. Everyone who has
contributed is named in AUTHORS.md,
with what they did.

Four contributions landed on top of this documentation work:

  • @pollychen-lab moved the download engine into a shared moon_download.py
    (#41) and moved the no-Chrome regression into a pytest suite (#38).
    download_file, Telemetry and ProxyPool existed as two copies before this,
    so every fix in the download path was a two-file change
  • @kushin25 wrote docs/CLI.md, the CLI reference (#37)
  • @NanoRisk6 pointed the documented verification commands at pytest tests/
    after the test move (#43)
  • @AdvaitVarhade narrowed native_dialog's exception handling so a real
    failure surfaces instead of returning an empty path (#54)

Contributors welcome

Open issues are scoped, with the files to touch and the acceptance criteria
written out. Most need no Windows machine — documentation, CI and dependency
work run anywhere, and the test suite stubs Chrome and the network so it runs on
any OS.

Start here: #39

Three good ones right now:

  • #56 — documentation-only pull requests currently run no checks at all. The
    docs make checkable claims about the CLI, and nothing checks them
  • #45--browsers does not control browsers. Rename it to --extractors
    and keep a deprecated alias
  • #55docs/ARCHITECTURE.md still describes the download engine as two
    copies, which #41 made untrue

No permission needed. Comment on an issue to claim it, then open a PR.