From 5a95b17a3544753293b7085c9bcc26bdba774ea6 Mon Sep 17 00:00:00 2001
From: zp6 <zp6@users.noreply.github.com>
Date: Fri, 15 May 2026 01:58:54 +0800
Subject: [PATCH] docs: add README badges and CONTRIBUTING guide

Add license, npm version, and contributing badges to README.
Create CONTRIBUTING.md with dev setup, coding style, and PR guidelines.

bounty:8e29b86d-2387-4a5a-bd72-69afaa74c4ad
---
 CONTRIBUTING.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++++
 README.md       |  4 +++
 2 files changed, 70 insertions(+)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 000000000..e08bc5302
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,66 @@
+# 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+ and **pnpm** (package manager)
+- **Rust** (latest stable) — install via [rustup.rs](https://rustup.rs)
+- **Git**
+
+### Getting Started
+
+```bash
+# Clone the repository
+git clone https://github.com/dextonai/agent-browser.git
+cd agent-browser
+
+# Install dependencies
+pnpm install
+
+# Build the project
+pnpm build
+
+# Build the native Rust binary
+pnpm build:native
+
+# Link globally for local development
+pnpm link --global
+```
+
+### Running Tests
+
+```bash
+pnpm test
+```
+
+## Coding Style
+
+- **TypeScript/JavaScript**: Follow the existing code style. Prettier is configured — run `pnpm format` before committing.
+- **Rust**: Follow standard Rust conventions (`cargo fmt`, `cargo clippy`).
+- **Commits**: Use clear, descriptive commit messages.
+
+## How to Submit a PR
+
+1. **Fork** the repository and create a feature branch from `main`.
+2. **Make your changes** with clear, focused commits.
+3. **Test** your changes locally.
+4. **Open a Pull Request** against the `main` branch of `dextonai/agent-browser`.
+5. Include a clear description of what the PR does and reference any related issues.
+
+### PR Guidelines
+
+- Keep PRs focused — one feature or fix per PR.
+- Add tests for new functionality when applicable.
+- Update documentation (README, inline docs) if your change affects the user-facing API.
+
+## Reporting Issues
+
+- Use [GitHub Issues](https://github.com/dextonai/agent-browser/issues) to report bugs or request features.
+- Include steps to reproduce, expected behavior, and actual behavior.
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the Apache-2.0 license.
diff --git a/README.md b/README.md
index 8ede376c9..99b4bf78f 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,9 @@
 # agent-browser
 
+[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+[![npm version](https://img.shields.io/npm/v/agent-browser.svg)](https://www.npmjs.com/package/agent-browser)
+[![Contributing](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](CONTRIBUTING.md)
+
 Browser automation CLI for AI agents. Fast native Rust CLI.
 
 ## Installation