Skip to content

docs: add CONTRIBUTING.md with development setup and PR guidelines #63

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
mercygg wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add CONTRIBUTING.md with development setup and PR guidelines #63

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
65 changes: 65 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Contributing to Agent Browser

Thanks for contributing! Here's how to get started.

## Development Environment Setup

```bash
# 1. Clone and install
git clone https://github.com/dextonai/agent-browser.git
cd agent-browser
npm install

# 2. Run tests to verify your setup
npm test

# 3. Start dev server (if applicable)
npm run dev
```

**Requirements**: Node.js >= 18, npm >= 9

## Coding Style

- **TypeScript** strict mode — all new code must be typed
- **Formatting**: Run `npm run format` before committing (uses Prettier)
- **Linting**: Run `npm run lint` — CI will fail on lint errors
- **Naming**: Use `camelCase` for variables/functions, `PascalCase` for classes/components
- **Imports**: Group imports: built-ins → third-party → local. Use named exports.
- **Comments**: Explain _why_, not _what_. The code should document itself.

## Submitting a Pull Request

1. **Fork** the repository and create a feature branch:
```bash
git checkout -b feat/your-feature-name
```

2. **Make your changes** — keep commits small and focused. One commit per logical change.

3. **Write tests** for new functionality. Existing tests must pass.

4. **Update documentation** if your change affects public APIs.

5. **Push and open a PR** against the `main` branch. In your PR description:
- What problem does this solve?
- How did you test it?
- Any breaking changes?

6. **CI checks** must pass before review. A maintainer will review within 3 business days.

## Reporting Issues

- Use the issue templates if available
- Include steps to reproduce, expected behavior, and actual behavior
- Share your environment: OS, Node version, browser version

## Communication

- Be respectful and constructive
- Follow the [Contributor Covenant](https://www.contributor-covenant.org/) code of conduct
- Tag issues appropriately with labels

## License

By contributing, you agree that your contributions will be licensed under the project's license.