Skip to content
Open
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
72 changes: 72 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# Contributing to agent-browser

Thank you for your interest in contributing to agent-browser! This guide will help you get started.

## Development Setup

### Prerequisites

- **Node.js** ≥ 18
- **Rust** (latest stable) — for native CLI builds
- **Chromium** — downloaded via `agent-browser install`

### Getting Started

```bash
# Clone the repository
git clone https://github.com/dextonai/agent-browser.git
cd agent-browser

# Install dependencies
npm install

# Download Chromium (required for tests)
npx agent-browser install

# Build the project
npm run build
```

### Running Tests

```bash
npm test
```

## Coding Style

- **TypeScript** — all Node.js source lives in `src/` and must type-check cleanly
- **Rust** — native CLI code follows standard `rustfmt` formatting (`cargo fmt`)
- Use **meaningful variable names** and keep functions focused
- Add **JSDoc / doc comments** for public APIs
- Run `npm run lint` (if available) before submitting

## How to Submit a Pull Request

1. **Fork** the repository on GitHub
2. **Create a branch** from `main`:
```bash
git checkout -b feat/my-feature
```
3. **Make your changes** — keep commits atomic and descriptive
4. **Test** your changes locally
5. **Push** to your fork:
```bash
git push origin feat/my-feature
```
6. **Open a Pull Request** against `dextonai/agent-browser:main`
- Describe what you changed and why
- Reference any related issues (e.g., `Fixes #123`)

## Reporting Issues

- Search existing issues before opening a new one
- Include steps to reproduce, expected vs. actual behavior, and your environment info

## Code of Conduct

Be respectful. We're all here to build something useful.

## License

By contributing, you agree that your contributions will be licensed under the [Apache 2.0 License](LICENSE).
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# agent-browser

[![npm version](https://img.shields.io/npm/v/agent-browser)](https://www.npmjs.com/package/agent-browser)
[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)

Headless browser automation CLI for AI agents. Fast Rust CLI with Node.js fallback.

## Installation
Expand Down