Skip to content

About

Windows desktop control plane for private Issue Scout repositories

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Issue Scout compass logo

Issue Scout

Find your next contribution. Review the evidence. Make it yours.

A Windows desktop workspace for finding open-source issues that fit your skills, preparing draft fixes and reviewing what Scout could actually validate.

License: MIT Version: 0.2.0 beta Platform: Windows x64 Installer: unsigned

Download the Windows installer (.exe)

Release notes and checksum · Get started · Roadmap · Report an issue

Free, MIT-licensed desktop app. Scouting uses your GitHub Actions minutes and model credentials.



Issue Scout in dark mode: runs and reports with verified, unverified and no-fix outcomes

Interface preview using offline sample data, not live contribution results.

Electron · React · TypeScript · Your GitHub Actions

Important

This Windows beta is unsigned. Windows may display an unknown-publisher or SmartScreen warning, or block installation on managed computers. The release includes a SHA-256 checksum. macOS support and automatic app updates are not available yet.

Contents

What it does

Issue Scout connects to your private copy of the Scout engine. Set your preferences in the app, run Scout in your own GitHub Actions, then review the outcome, validation evidence and available patch.

In your workspace What you can do
Runs & reports Start or stop a scout, follow its status, inspect recorded outcomes and download saved artifacts.
Your profile Describe your skills, preferred languages and the work you want to contribute.
History See issues recorded by your Scout repository.
Scout settings Configure Discovery, Models, Schedule and optional Email reports.
Account Manage GitHub sign-in and the Scout repository connected on this computer.

The interface distinguishes verified fixes, unverified drafts, no-fix outcomes and runs with no suitable issue. A successful GitHub Actions run alone does not count as a verified fix. When evidence is missing or unavailable, the app says so.

Experimental: bug explanations. A run's report has an Explain tab: one diagram of how the bug happens, where the fix steps in and why, shown as Before, After and Changes. Select a step to see its code in the original or patched version, Scout's explanation, and the recorded checks tied to it. Every step and connection says whether it was reported in the issue or is Scout's reading of the code; a diagram never changes a run's outcome. Diagrams need an engine that saves a source-checked explanation, which the public template doesn't do yet. Until then the tab says why no diagram is shown and lists the saved changes and Scout's reasoning, and reports open on the Review brief. The tab is new in 0.2.0.

The Explain tab's Changes view for a real python-docx fix: the reported failure removed by the patch, the added fix step, and the inspector showing the original line raise NotImplementedError matched against the saved patch

The 0.2.0 app's Explain tab on a real run for python-docx #1313. That run used a private test copy of the engine; the public template doesn't save diagrams yet.

You decide what to contribute. Scout prepares drafts and evidence for your review; it does not claim issues, post comments or open pull requests on target projects for you.

How it works

Issue Scout desktop
        |
        | GitHub API
        v
Your private Scout repository
        |
        | Your GitHub Actions + chosen models
        v
Discover -> shortlist -> check suitability -> draft -> validate -> save report
        |
        v
Review the outcome and available patch in the app
  1. Connect GitHub. Sign in through GitHub's device authorization flow.
  2. Make Scout yours. Create a private repository from the template or connect an existing Scout copy.
  3. Choose the work and models. Set your profile, discovery preferences and credentials for each stage.
  4. Run or schedule a scout. Work happens in your repository's GitHub Actions.
  5. Review before contributing. Read the brief, patch, validation logs and PR preparation material.

The desktop app manages your repository. The separate template supplies the engine that runs each scout.

Getting started

Install the app

Download Issue-Scout-Setup-0.2.0-x64.exe

Run the installer, open Issue Scout, then:

  1. Sign in with your own GitHub account.
  2. Create a new private Scout repository or connect an existing one.
  3. Save your profile and discovery preferences.
  4. Open Scout settings → Models, choose your models and save their credentials until setup is complete.
  5. Open Runs & reports and select Run full scout.

You do not need to clone this repository, install Node.js or set up GitHub CLI to use the installer. You do need access to GitHub Actions and valid credentials for your chosen models.

Check the download

Compare the downloaded installer's hash with SHA256SUMS.txt on the release page:

Get-FileHash .\Issue-Scout-Setup-0.2.0-x64.exe -Algorithm SHA256

The checksum helps detect a changed download; it does not replace a publisher signature.

Existing repositories and updates

An existing Scout repository keeps the engine version it was created with. Older engines may not save structured outcomes, so their reports can appear as Completed without verified/unverified details. Connecting the app does not upgrade that engine automatically.

App updates are currently manual: download a newer installer and run it over the existing installation. Your saved account data is preserved. The app does not check for or install updates automatically.

Models and languages

Choose models independently for issue picking and fix drafting.

Provider Supported stages Authentication
Claude Code Picking and drafting Subscription token or API key
Codex Picking and drafting API key
OpenAI Picking and drafting API key
Anthropic Picking and drafting API key
OpenAI-compatible HTTPS endpoint Picking and drafting API key
Groq Picking only API key

Provider access and billing depend on your own account. Subscription authentication is not offered for Codex on GitHub-hosted runners. A custom endpoint must be reachable from the GitHub Actions runner.

The app knows Python, JavaScript, TypeScript, C#, C, Go, Rust, Java and C++, plus documentation contributions. The available languages follow the connected repository's engine capabilities; older repositories may offer fewer. Validation also depends on whether Scout can build and test the target project in an available runtime.

Your data and costs

  • Scouting runs in your account. GitHub Actions minutes and model usage belong to you and are subject to your accounts' limits and pricing.
  • The desktop app is free. Optional report emails use the maintainer's hosted relay and Resend account, with delivery limits to control the shared cost.
  • Your configuration lives in your private Scout repository. Model credentials are saved as GitHub Secrets; the profile and scouting settings are stored in profile.json.
  • GitHub sign-in stays in the main process. The app stores its token through Electron's safeStorage. The sandboxed renderer never receives that token.
  • Email is opt-in. Enabling it requires address confirmation. The relay processes the delivery address and report email content; the maintainer's Resend API key stays on the relay.

Disconnecting a repository only forgets this computer's link; it does not delete the repository on GitHub. Signing out or disconnecting does not erase email records already held by the relay.

Roadmap

  • CI/CD to test, build and publish Windows releases.
  • Code signing for Windows installers and update packages.
  • In-app update checks and automatic (OTA) updates after code signing is established.
  • Scout engine updates that preserve existing repositories' settings and data.
  • macOS support; currently deferred while Windows is the supported platform.

Future directions: personalization and visual understanding

The bug explainer is in progress, and its Explain tab is in the 0.2.0 beta; the others are proposed contributor projects.

  • Contribution-based personalization. Opt-in import of authored PRs, merged contributions and changed files to improve issue recommendations. Combine observed experience with explicit feedback and learning goals; let users inspect, correct, reset or disable learned preferences. Track actual contributions separately from Scout's attempted-issue history.
  • Contribution knowledge graph. Explore connections between contributions, repositories, languages, topics and suggested issues. Link recommendations to supporting evidence, distinguish observed facts from inferred topics, and provide a searchable list alternative.
  • Visual bug explainer (in progress). Done in the app: Before/After/Changes diagrams, code references checked against the saved patch (the engine checks them against the original commit), recorded checks beside the steps they concern, keyboard navigation, a text alternative and a hand-written sample page. One live run has produced a source-checked diagram, using a private test copy of the engine. Remaining: the engine change in the public template, a release that includes it, screen-reader and display-scaling checks, and optional Markdown or Obsidian Canvas export. Unverified explanations and missing evidence stay marked; a diagram must never establish a verified-fix outcome on its own.

Suggested sequence for the rest: contribution import → editable preference feedback → interactive contribution graph. Public contributions would be the default; private-repository analysis would require explicit opt-in. Imported history would stay in local storage or the user's private Scout repository, with model-analysis costs under the user's control.

Contributor work can be split across GitHub integration, preference ranking, graph/accessibility UI, structured engine artifacts and offline evaluation/privacy fixtures.

Development

The steps below are for contributors. Installer users can skip this section.

git clone https://github.com/atty57/issue-scout-app.git
cd issue-scout-app
npm ci
npm start
Command Purpose
npm test Run frontend journeys and Electron backend tests.
npm run build Type-check and build the production renderer.
npm start Build and launch Electron.
npm run start:samples Build and launch Electron with the hand-written bug-explainer samples.
npm run dist:win Build a local Windows x64 installer in release/; never publishes.

To try the bug explainer without a run, start the app with npm run start:samples and open Preview: sample bug explanation in the page footer. Its three examples are written by hand and labelled as such; release builds leave the page out. The design, the evidence rules and the optional engine fields are in docs/evidence-walkthrough.md.

The optional signed-build tooling is documented in RELEASING.md. No signing service is configured for the current unsigned beta.

src/        React interface, shared components and frontend tests
electron/   Main process, GitHub integration, preload bridge and backend tests
docs/       Design notes, including the bug explainer's specification
build/      Application icons and optional signing configuration
scripts/    Release build and signature-verification helpers

The renderer calls one IPC request channel through window.scout.request; backend routes handle GitHub access in the main process. The template repository contains the separate scouting engine and Actions workflows copied into each user's private repository.

Contributing

Report bugs or suggest improvements. Include your app version, steps to reproduce and the expected versus actual behavior. Do not include tokens, model keys, device authorization codes or private reports in public issues.

For code changes, keep tests offline, run npm test and npm run build, and include screenshots for interface changes. Preserve the distinction between recorded validation evidence and unavailable results.

License and acknowledgements

Issue Scout desktop is licensed under the MIT License. Third-party components retain their respective licenses.

About

Windows desktop control plane for private Issue Scout repositories

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages