From de08dc984866f0e70c400206b5752d469be2ff7a Mon Sep 17 00:00:00 2001 From: onchito-walks Date: Mon, 11 May 2026 08:06:19 -0400 Subject: [PATCH 1/2] Add CONTRIBUTING.md with setup, style guide, and PR guidelines --- CONTRIBUTING.md | 77 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..21dd49f0e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,77 @@ +# Contributing to agent-browser + +Thank you for your interest in contributing! This guide covers everything you need. + +## Development Setup + +### Prerequisites +- Node.js 18+ and npm +- Rust toolchain (for native CLI): `curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh` +- Chrome for Testing (auto-installed via `agent-browser install`) + +### Getting Started +```bash +git clone https://github.com/dextonai/agent-browser.git +cd agent-browser +npm install +agent-browser install +``` + +### Running Tests +```bash +npm test +``` + +### Building from Source +```bash +# Build the Rust CLI +cargo build --release + +# Build the npm package +npm run build +``` + +## Coding Style + +### TypeScript/JavaScript +- Use strict TypeScript (`strict: true`) +- Prefer `const` over `let`; avoid `var` +- Use async/await over raw promises +- Add JSDoc comments to exported functions +- Follow existing formatting (Prettier defaults) + +### Rust +- Follow `rustfmt` defaults: `cargo fmt` +- Run Clippy before submitting: `cargo clippy -- -D warnings` +- Add doc comments (`///`) to public items +- Handle errors with `Result`, never panic in library code + +## Submitting Changes + +1. Fork this repository +2. Create a feature branch: `git checkout -b feature/my-change` +3. Make focused, atomic commits with clear messages +4. Add or update tests for your changes +5. Run the full test suite: `npm test && cargo test` +6. Open a Pull Request with: + - Clear description of the change + - Link to any related issues + - Steps to test manually if applicable + +## Pull Request Guidelines + +- Keep PRs small and focused — one concern per PR +- Include tests for new functionality +- Update documentation if behavior changes +- Be responsive to review feedback + +## Reporting Issues + +- Search existing issues before opening a new one +- Include: Node.js version, Rust version, OS +- Provide minimal reproduction steps +- Show relevant logs or error output + +## Questions? + +Open an issue or start a discussion on this repo. From 43c00666f5e46efd3983ba60e6ed5528e6a880b5 Mon Sep 17 00:00:00 2001 From: onchito-walks Date: Mon, 11 May 2026 08:06:46 -0400 Subject: [PATCH 2/2] Add build status badge to README --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 8ede376c9..6f53a5bdc 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # agent-browser +[![Build Status](https://github.com/dextonai/agent-browser/actions/workflows/ci.yml/badge.svg)](https://github.com/dextonai/agent-browser/actions) + Browser automation CLI for AI agents. Fast native Rust CLI. ## Installation