From 04f9ab688bc039585b970ab5d6e9f17ae9ae7794 Mon Sep 17 00:00:00 2001 From: Tamer Tawil Date: Tue, 24 Mar 2026 03:17:11 +0300 Subject: [PATCH] docs: add CONTRIBUTING.md and CI status badge (#1) --- CONTRIBUTING.md | 24 ++++++++++++++++++++++++ README.md | 2 ++ 2 files changed, 26 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..675ed389b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,24 @@ +# Contributing to Agent Browser + +Thank you for your interest in contributing to Agent Browser! We welcome contributions from the community. + +## How to Contribute + +### 1. Set Up Development Environment +- Ensure you have Node.js (v18+) and npm installed. +- Clone the repository: `git clone https://github.com/dextonai/agent-browser.git` +- Install dependencies: `npm install` + +### 2. Coding Guidelines +- Follow the existing code style. +- Use TypeScript for all new code. +- Ensure all tests pass before submitting a PR. + +### 3. Submitting a Pull Request +- Create a new branch for your feature or bug fix: `git checkout -b feature/your-feature-name` +- Commit your changes with a descriptive message. +- Push to your fork and submit a Pull Request to the `main` branch. +- Reference any related issues in the PR description. + +## Bug Reports and Feature Requests +Please use the GitHub Issues tracker to report bugs or suggest new features. diff --git a/README.md b/README.md index 7b0dfba9a..5f7a15b51 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +[![Build Status](https://github.com/dextonai/agent-browser/actions/workflows/ci.yml/badge.svg)](https://github.com/dextonai/agent-browser/actions) + # agent-browser Headless browser automation CLI for AI agents. Fast Rust CLI with Node.js fallback.