Skip to content

Latest commit

 

History

History
99 lines (73 loc) · 3.46 KB

CONTRIBUTING.md

File metadata and controls

99 lines (73 loc) · 3.46 KB

Contributing to browser-use MCP Server

First off, thank you for considering contributing to browser-use MCP Server! This project is released under the MIT License, which means your contributions will also be covered under the same permissive license.

Table of Contents

Code of Conduct

We have adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Getting Started

Fork-based workflow (recommended as a playground)

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/your-username/browser-use-mcp-server.git
  3. Create a new branch: git checkout -b feature/your-feature-name
  4. Make your changes
  5. Push to your fork: git push origin feature/your-feature-name
  6. Open a Pull Request

Direct repository workflow (for contributors)

  1. Clone the repository directly: git clone https://github.com/co-browser/browser-use-mcp-server.git
  2. Create a new branch: git checkout -b feature/your-feature-name
  3. Make your changes
  4. Push to the repository: git push origin feature/your-feature-name
  5. Open a Pull Request

If you're interested in being contributor, please reach out to the maintainers after making a few successful contributions via issues and pull requests.

How to Contribute

Guidelines for Non-Code Contributions

We appreciate your attention to detail. However, minor fixes like typos or grammar corrections should not be submitted individually. Instead, create an issue noting these corrections, and we'll batch them into larger updates.

Reporting Bugs

We use GitHub issues to track bugs. Before creating a bug report:

  • Search existing Issues to ensure it hasn't already been reported
  • If you find a closed issue that seems to address your problem, open a new issue and include a link to the original

When submitting a bug report, please use our bug report template and include as much detail as possible.

Suggesting Enhancements

Enhancement suggestions are tracked through GitHub issues. Please use our feature request template when suggesting enhancements.

Pull Requests

  • Follow our pull request template
  • Include screenshots and animated GIFs in your pull request whenever possible
  • Follow our coding conventions and style guidelines
  • Write meaningful commit messages
  • Update documentation as needed
  • Add tests for new features
  • Pull requests undergo automated checks, including build and linting

Development Process

  1. Pick an issue to work on or create a new one
  2. Comment on the issue to let others know you're working on it
  3. Create a branch with a descriptive name
  4. Write your code following our style guidelines
  5. Add tests for new functionality
  6. Update documentation as needed
  7. Submit a pull request
  8. Respond to code review feedback

License

By contributing to browser-use MCP Server, you agree that your contributions will be licensed under the MIT License. See LICENSE for details.