Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ A clear description of what went wrong.
- Is it Electron-based? (yes/no, and how you know)

**Output**
Remove any app names or other information you do not want to share publicly. Please include the detector version (`bash electron-detector.sh --version`).
```
paste the output of `./electron-detector.sh --json` or the terminal output here
```
39 changes: 5 additions & 34 deletions .github/banner.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
41 changes: 41 additions & 0 deletions .github/preview.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 3 additions & 34 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,7 @@
# Contributing

Thanks for considering a contribution to Electron Detector.
Keep the scanner compatible with macOS `/bin/bash` 3.2 and system utilities. See [the technical reference](docs/reference.md) for the JSON contract and test commands. Add regression fixtures for detection, path handling, and output changes. Avoid performance claims that the scanner cannot measure, and keep all scan data local. A missing Electron marker is never proof of native architecture.

## Ways to help
When reporting issues, include macOS and script versions and the detection marker you expected. Review reports before posting: app names may reveal personal information.

- **New detection rules** — if you know of an app that hides its Electron internals differently, open a PR adding a check to `is_electron()` in `electron-detector.sh`, or open an issue with the app name/version and we'll add it.
- **Bug fixes** — if the script misbehaves on your setup, please include your macOS version and `bash --version`.
- **README / docs** — typo fixes and clarity improvements are always welcome.

## Development

The project is a single dependency-free Bash script, kept that way on purpose.

```bash
git clone https://github.com/macnative/electron-detector.git
cd electron-detector
chmod +x electron-detector.sh
./electron-detector.sh
```

Before opening a PR:

- Run [ShellCheck](https://www.shellcheck.net/) against `electron-detector.sh` (CI runs this automatically on every PR).
- Test both the default and `--json`/`--user`/`--quiet` flag combinations.
- Keep the script POSIX-friendly Bash — no external binaries beyond what macOS ships by default (`find`, `du`, `defaults`, `basename`).

## Reporting an issue

Open a [GitHub issue](https://github.com/macnative/electron-detector/issues) with:

- Your macOS version
- The app you expected to be detected (or misdetected), with its version
- Output of `./electron-detector.sh --json` if relevant

## Code of conduct

Be respectful and constructive. This is a small tool built for fun and utility — let's keep it a pleasant place to contribute.
After changing the terminal output, run `python3 scripts/render-preview.py` on macOS to regenerate the README preview from `--demo`. Keep the example label visible. Never use a real user's installed apps in promotional assets.
Loading
Loading