Skip to content

docs: add build status badge and CONTRIBUTING.md #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yolopsx wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add build status badge and CONTRIBUTING.md #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down