Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
92 lines (65 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

92 lines (65 loc) · 2.19 KB

Contributing to Browser Use Desktop

Install these first:

  • Task (brew install go-task on macOS)
  • Node.js 22
  • Yarn

From root:

git clone https://github.com/browser-use/desktop.git
cd desktop
task up

task up installs dependencies, patches the local Electron app bundle, and starts the desktop app.

Useful development commands:

task --list          # show available tasks
task lint            # run ESLint
task typecheck       # run tsc --noEmit
cd app && yarn test  # run unit and integration tests
task make            # build platform installers

Linux packages are built in Docker:

task linux:make:docker

Pull requests

Great PRs are focused and easy to review:

  1. Explain why the change is needed.
  2. Keep the PR scoped to one bug fix, feature, or cleanup.
  3. Include screenshots or a short recording for UI changes.

To get your PR reviewed faster, you can message any of the Browser Use employees on discord, twitter, or email.

Reporting bugs

Open an issue at browser-use/desktop/issues with enough detail for someone else to reproduce the problem.

Good bug reports include:

  • The app version / git commit.
  • Your operating system.
  • The provider you were using, such as Claude Code or Codex.
  • Clear steps to reproduce the issue.
  • What you expected to happen and what happened instead.
  • Screenshots or recordings when the bug is visible.
  • Relevant logs, with secrets and private URLs redacted.

Helpful log commands:

task logs:all
task logs:app
task logs:browser
task logs:agent SESSION_ID=<session-id>
task logs:engine
task logs:errors

By default, local logs are read from:

~/Library/Application Support/Browser Use/logs

Feature Reuests

Please describe both a problem + solution! Include:

  • Why the current app does not solve it well / atall.
  • The specific outcome you want.
  • Screenshots, recordings, or example sites if they clarify the request.

If you plan to send a PR for the feature, open an issue first! and tag it in your PR.

Where to ask questions

Browser Use Discord Twitter