From 06937caad80574a8ca9c23abe0d715a012ccf2e2 Mon Sep 17 00:00:00 2001 From: Wu MingDa Date: Mon, 18 May 2026 11:46:01 +0800 Subject: [PATCH] Add CONTRIBUTING.md with setup and PR guidelines --- CONTRIBUTING.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..22bc561e8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,61 @@ +# Contributing to agent-browser + +Thank you for your interest in contributing! This document provides guidelines and instructions for contributing. + +## Getting Started + +1. Fork the repository +2. Clone your fork: `git clone https://github.com/YOUR_USERNAME/agent-browser.git` +3. Install dependencies: `pnpm install` +4. Build the project: `pnpm build` + +## Development Setup + +### Prerequisites + +- Node.js 18+ +- pnpm +- Rust (for native builds) + +### Setup + +1. Install dependencies: + ```bash + pnpm install + ``` + +2. Build the project: + ```bash + pnpm build + ``` + +3. Run tests: + ```bash + pnpm test + ``` + +## Pull Request Guidelines + +1. Keep PRs focused on a single change +2. Write clear commit messages +3. Include tests for new features +4. Update documentation as needed +5. Ensure all tests pass before submitting + +## Code Style + +- Follow the existing code style +- Use Prettier for formatting +- Run `pnpm lint` to check for linting issues +- Write meaningful variable and function names + +## Reporting Issues + +- Use the issue tracker +- Include reproduction steps +- Include error messages and logs +- Specify your environment (OS, Node.js version) + +## Questions? + +Feel free to ask questions in the issues or discussions.