diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..e1e5b74df --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,35 @@ +# Contributing to agent-browser + +Thanks for your interest in 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: `cargo build --release` + +## Development Workflow + +- Create a feature branch: `git checkout -b feat/your-feature` +- Make your changes +- Run tests: `cargo test` +- Commit using conventional commits: `feat:`, `fix:`, `docs:`, `chore:` +- Push and open a Pull Request + +## Pull Request Guidelines + +- Keep PRs focused on a single change +- Update documentation if needed +- Add tests for new features +- Ensure CI passes + +## Code Style + +- Rust: follow standard `rustfmt` conventions +- TypeScript: follow the project's ESLint configuration +- Commit messages: follow [Conventional Commits](https://www.conventionalcommits.org/) + +## Questions? + +Open an issue or start a discussion! diff --git a/README.md b/README.md index 8ede376c9..dc2a8f487 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # agent-browser +\n[![npm version](https://img.shields.io/npm/v/agent-browser)](https://www.npmjs.com/package/agent-browser) [![License](https://img.shields.io/github/license/dextonai/agent-browser)](LICENSE) Browser automation CLI for AI agents. Fast native Rust CLI.