diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..ae39df13c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# Contributing to agent-browser + +## Dev environment setup + +```bash +git clone https://github.com/dextonai/agent-browser.git +cd agent-browser +npm install +npm run build +``` + +Requirements: Node.js 22+, npm 10+. The project is written in TypeScript and uses the `agent-browser` CLI for headless browser automation. + +## Coding style guidelines + +- TypeScript strict mode — all code must pass `tsc --noEmit` +- Prettier formatting with default config (2-space indent, single quotes, trailing commas) +- Functions use explicit return types unless inferrable from context +- Exported functions include JSDoc comments describing parameters and return values +- Error handling: use try/catch for browser operations, propagate meaningful error messages + +## How to submit a PR + +1. Fork the repository +2. Create a feature branch: `git checkout -b feat/your-change` +3. Make your changes and write/update tests +4. Run `npm test` and `npm run lint` to verify +5. Commit with a descriptive message: `feat: description` or `fix: description` +6. Push and open a Pull Request against the `main` branch +7. Reference any related issues in the PR description diff --git a/README.md b/README.md index 8ede376c9..a37b8d719 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # agent-browser +[![Build Status](https://github.com/dextonai/agent-browser/actions/workflows/build.yml/badge.svg)](https://github.com/dextonai/agent-browser/actions/workflows/build.yml) + Browser automation CLI for AI agents. Fast native Rust CLI. ## Installation