From 90e96c0c14f9b19f483cdec2750c84e8670190ab Mon Sep 17 00:00:00 2001 From: Michel Osswald Date: Tue, 18 Mar 2025 15:29:19 +0100 Subject: [PATCH 1/6] added contribution docs --- CONTRIBUTING.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2d95ab8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,53 @@ +# Contributing to browser-use MCP Server + +### Table of Contents + +- [Code of Conduct](#code-of-conduct) +- [How to Contribute](#how-to-contribute) + - [Guidelines for Non-Code Contributions](#guidelines-for-non-code-contributions) + - [Reporting Bugs](#reporting-bugs) + - [Suggesting Enhancements](#suggesting-enhancements) + - [Pull Requests](#pull-requests) + +## Code of Conduct +This project follows a respectful and inclusive environment. By contributing, you agree to maintain a welcoming atmosphere. Any unacceptable behavior should be reported directly to the maintainers. + +## 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 + +#### Before Submitting a Bug +- Search existing [Issues](https://github.com/co-browser/browser-use-mcp-server/issues) to ensure it hasn't already been reported. + +#### How to Submit a Good Bug Report +- Open a new issue with a descriptive title. +- Clearly describe the problem, including: + - Exact reproduction steps. + - Commands or actions taken. + - Observed behavior and expected behavior. + - Include code snippets, screenshots, or logs formatted using Markdown. + - Confirm if the issue is reproducible and under what conditions it occurs. + +### Suggesting Enhancements + +#### Before Submitting an Enhancement +- Search existing [Issues](https://github.com/co-browser/browser-use-mcp-server/issues) to avoid duplicates. + +#### How to Submit a Good Enhancement Suggestion +- Clearly and descriptively title your issue. +- Provide a detailed explanation of the enhancement. +- Describe current vs. desired behavior. +- Explain why this enhancement benefits the project and its users. +- Specify your OS and relevant software versions if applicable. + +### Pull Requests +- Pull requests undergo automated checks, including build and linting. Ensure these checks pass. +- Ensure your PR addresses the following: + - Clearly described purpose and benefits. + - Consistent code style and formatting. +- Clearly document commit messages, providing detailed context for substantial changes. +- PRs focused solely on formatting without functional improvements will generally be rejected. + From 5dca7facf1edb1d559a0e633b134c1ab74ac92db Mon Sep 17 00:00:00 2001 From: Michel Osswald Date: Tue, 18 Mar 2025 15:32:00 +0100 Subject: [PATCH 2/6] formatting fixes --- CONTRIBUTING.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2d95ab8..9b1e7a1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,19 +10,23 @@ - [Pull Requests](#pull-requests) ## Code of Conduct + This project follows a respectful and inclusive environment. By contributing, you agree to maintain a welcoming atmosphere. Any unacceptable behavior should be reported directly to the maintainers. ## 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 #### Before Submitting a Bug + - Search existing [Issues](https://github.com/co-browser/browser-use-mcp-server/issues) to ensure it hasn't already been reported. #### How to Submit a Good Bug Report + - Open a new issue with a descriptive title. - Clearly describe the problem, including: - Exact reproduction steps. @@ -34,9 +38,11 @@ We appreciate your attention to detail. However, minor fixes like typos or gramm ### Suggesting Enhancements #### Before Submitting an Enhancement + - Search existing [Issues](https://github.com/co-browser/browser-use-mcp-server/issues) to avoid duplicates. #### How to Submit a Good Enhancement Suggestion + - Clearly and descriptively title your issue. - Provide a detailed explanation of the enhancement. - Describe current vs. desired behavior. @@ -44,10 +50,10 @@ We appreciate your attention to detail. However, minor fixes like typos or gramm - Specify your OS and relevant software versions if applicable. ### Pull Requests + - Pull requests undergo automated checks, including build and linting. Ensure these checks pass. - Ensure your PR addresses the following: - Clearly described purpose and benefits. - Consistent code style and formatting. - Clearly document commit messages, providing detailed context for substantial changes. - PRs focused solely on formatting without functional improvements will generally be rejected. - From 571174b255b80734f727b31006512e91835410a5 Mon Sep 17 00:00:00 2001 From: Michel Osswald Date: Tue, 18 Mar 2025 15:35:24 +0100 Subject: [PATCH 3/6] prettier formatting fixes --- CONTRIBUTING.md | 25 ++++++++++++++++++------- 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9b1e7a1..1c36f94 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,19 +11,25 @@ ## Code of Conduct -This project follows a respectful and inclusive environment. By contributing, you agree to maintain a welcoming atmosphere. Any unacceptable behavior should be reported directly to the maintainers. +This project follows a respectful and inclusive environment. By contributing, +you agree to maintain a welcoming atmosphere. Any unacceptable behavior should +be reported directly to the maintainers. ## 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. +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 #### Before Submitting a Bug -- Search existing [Issues](https://github.com/co-browser/browser-use-mcp-server/issues) to ensure it hasn't already been reported. +- Search existing + [Issues](https://github.com/co-browser/browser-use-mcp-server/issues) to + ensure it hasn't already been reported. #### How to Submit a Good Bug Report @@ -39,7 +45,9 @@ We appreciate your attention to detail. However, minor fixes like typos or gramm #### Before Submitting an Enhancement -- Search existing [Issues](https://github.com/co-browser/browser-use-mcp-server/issues) to avoid duplicates. +- Search existing + [Issues](https://github.com/co-browser/browser-use-mcp-server/issues) to avoid + duplicates. #### How to Submit a Good Enhancement Suggestion @@ -51,9 +59,12 @@ We appreciate your attention to detail. However, minor fixes like typos or gramm ### Pull Requests -- Pull requests undergo automated checks, including build and linting. Ensure these checks pass. +- Pull requests undergo automated checks, including build and linting. Ensure + these checks pass. - Ensure your PR addresses the following: - Clearly described purpose and benefits. - Consistent code style and formatting. -- Clearly document commit messages, providing detailed context for substantial changes. -- PRs focused solely on formatting without functional improvements will generally be rejected. +- Clearly document commit messages, providing detailed context for substantial + changes. +- PRs focused solely on formatting without functional improvements will + generally be rejected. From 4b9540580ade3b36ff3687ea8b112ec82507fb3f Mon Sep 17 00:00:00 2001 From: Tobias Date: Wed, 26 Mar 2025 22:10:15 +0100 Subject: [PATCH 4/6] Add LICENSE file to publish repo under MIT License --- LICENSE | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..12ac0e7 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 cobrowser.xyz + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. From c2689d7fde5104958a4974dd9ae66e82f597f904 Mon Sep 17 00:00:00 2001 From: Tobias Date: Wed, 26 Mar 2025 22:22:22 +0100 Subject: [PATCH 5/6] Add Code of Conduct and update contributing guidelines - Introduced a Contributor Covenant Code of Conduct to promote a respectful and inclusive community. - Updated CONTRIBUTING.md to include a link to the Code of Conduct, added a 'Getting Started' section, and refined the guidelines for reporting bugs and suggesting enhancements. - Added templates for bug reports and feature requests to streamline issue tracking and contributions. --- .github/ISSUE_TEMPLATE/bug_report.md | 32 ++++++ .github/ISSUE_TEMPLATE/feature_request.md | 19 ++++ .github/pull_request_template.md | 24 ++++ CODE_OF_CONDUCT.md | 132 ++++++++++++++++++++++ CONTRIBUTING.md | 86 ++++++++------ 5 files changed, 257 insertions(+), 36 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/pull_request_template.md create mode 100644 CODE_OF_CONDUCT.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..077226e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,32 @@ +--- +name: Bug Report +about: Create a report to help us improve +title: '[BUG] ' +labels: bug +assignees: '' +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Environment (please complete the following information):** +- OS: [e.g. macOS, Windows, Linux] + - Version [e.g. 1.2.3] +- Client [if applicable] + - Version [e.g. 1.2.3] + +**Additional context** +Add any other context about the problem here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..b179df3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,19 @@ +--- +name: Feature Request +about: Suggest an idea for this project +title: '[FEATURE] ' +labels: enhancement +assignees: '' +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..3756871 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,24 @@ +## Description +Please include a summary of the changes and which issue is fixed. Please also include relevant motivation and context. + +Fixes # (issue) + +## Type of change +Please delete options that are not relevant. + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Documentation update + +## How Has This Been Tested? +Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. + +## Checklist: +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing unit tests pass locally with my changes (if applicable) \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..2b63f9d --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,132 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official email address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +[info at cobrowser.xyz]. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1c36f94..1e9fb6d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,19 +1,41 @@ # 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](#code-of-conduct) +- [Getting Started](#getting-started) - [How to Contribute](#how-to-contribute) - [Guidelines for Non-Code Contributions](#guidelines-for-non-code-contributions) - [Reporting Bugs](#reporting-bugs) - [Suggesting Enhancements](#suggesting-enhancements) - [Pull Requests](#pull-requests) +- [Development Process](#development-process) +- [License](#license) ## Code of Conduct -This project follows a respectful and inclusive environment. By contributing, -you agree to maintain a welcoming atmosphere. Any unacceptable behavior should -be reported directly to the maintainers. +We have adopted a Code of Conduct that we expect project participants to adhere to. Please read [the full text](CODE_OF_CONDUCT.md) 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 @@ -25,46 +47,38 @@ issue noting these corrections, and we'll batch them into larger updates. ### Reporting Bugs -#### Before Submitting a Bug +We use GitHub issues to track bugs. Before creating a bug report: -- Search existing - [Issues](https://github.com/co-browser/browser-use-mcp-server/issues) to - ensure it hasn't already been reported. +- Search existing [Issues](https://github.com/co-browser/browser-use-mcp-server/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 -#### How to Submit a Good Bug Report - -- Open a new issue with a descriptive title. -- Clearly describe the problem, including: - - Exact reproduction steps. - - Commands or actions taken. - - Observed behavior and expected behavior. - - Include code snippets, screenshots, or logs formatted using Markdown. - - Confirm if the issue is reproducible and under what conditions it occurs. +When submitting a bug report, please use our bug report template and include as much detail as possible. ### Suggesting Enhancements -#### Before Submitting an Enhancement +Enhancement suggestions are tracked through GitHub issues. Please use our feature request template when suggesting enhancements. + +### Pull Requests -- Search existing - [Issues](https://github.com/co-browser/browser-use-mcp-server/issues) to avoid - duplicates. +- 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 -#### How to Submit a Good Enhancement Suggestion +## Development Process -- Clearly and descriptively title your issue. -- Provide a detailed explanation of the enhancement. -- Describe current vs. desired behavior. -- Explain why this enhancement benefits the project and its users. -- Specify your OS and relevant software versions if applicable. +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 -### Pull Requests +## License -- Pull requests undergo automated checks, including build and linting. Ensure - these checks pass. -- Ensure your PR addresses the following: - - Clearly described purpose and benefits. - - Consistent code style and formatting. -- Clearly document commit messages, providing detailed context for substantial - changes. -- PRs focused solely on formatting without functional improvements will - generally be rejected. +By contributing to browser-use MCP Server, you agree that your contributions will be licensed under the MIT License. See [LICENSE](LICENSE) for details. From 5f301028d4634535711330766282e544fd87581e Mon Sep 17 00:00:00 2001 From: Tobias Date: Wed, 26 Mar 2025 22:27:58 +0100 Subject: [PATCH 6/6] Format markdown files --- .github/ISSUE_TEMPLATE/bug_report.md | 22 +++++++------- .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++------- .github/pull_request_template.md | 15 +++++++--- CODE_OF_CONDUCT.md | 30 +++++++++---------- CONTRIBUTING.md | 35 ++++++++++++++++------- 5 files changed, 71 insertions(+), 51 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 077226e..392a205 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,32 +1,30 @@ --- name: Bug Report about: Create a report to help us improve -title: '[BUG] ' +title: "[BUG] " labels: bug -assignees: '' +assignees: "" --- -**Describe the bug** -A clear and concise description of what the bug is. +**Describe the bug** A clear and concise description of what the bug is. + +**To Reproduce** Steps to reproduce the behavior: -**To Reproduce** -Steps to reproduce the behavior: 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error -**Expected behavior** -A clear and concise description of what you expected to happen. +**Expected behavior** A clear and concise description of what you expected to +happen. -**Screenshots** -If applicable, add screenshots to help explain your problem. +**Screenshots** If applicable, add screenshots to help explain your problem. **Environment (please complete the following information):** + - OS: [e.g. macOS, Windows, Linux] - Version [e.g. 1.2.3] - Client [if applicable] - Version [e.g. 1.2.3] -**Additional context** -Add any other context about the problem here. \ No newline at end of file +**Additional context** Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index b179df3..bbcc2bb 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,19 +1,19 @@ --- name: Feature Request about: Suggest an idea for this project -title: '[FEATURE] ' +title: "[FEATURE] " labels: enhancement -assignees: '' +assignees: "" --- -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +**Is your feature request related to a problem? Please describe.** A clear and +concise description of what the problem is. Ex. I'm always frustrated when [...] -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +**Describe the solution you'd like** A clear and concise description of what you +want to happen. -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +**Describe alternatives you've considered** A clear and concise description of +any alternative solutions or features you've considered. -**Additional context** -Add any other context or screenshots about the feature request here. \ No newline at end of file +**Additional context** Add any other context or screenshots about the feature +request here. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 3756871..4af3d37 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,24 +1,31 @@ ## Description -Please include a summary of the changes and which issue is fixed. Please also include relevant motivation and context. + +Please include a summary of the changes and which issue is fixed. Please also +include relevant motivation and context. Fixes # (issue) ## Type of change + Please delete options that are not relevant. - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) -- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Breaking change (fix or feature that would cause existing functionality to + not work as expected) - [ ] Documentation update ## How Has This Been Tested? -Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. + +Please describe the tests that you ran to verify your changes. Provide +instructions so we can reproduce. ## Checklist: + - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works -- [ ] New and existing unit tests pass locally with my changes (if applicable) \ No newline at end of file +- [ ] New and existing unit tests pass locally with my changes (if applicable) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 2b63f9d..6b3061c 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -17,23 +17,23 @@ diverse, inclusive, and healthy community. Examples of behavior that contributes to a positive environment for our community include: -* Demonstrating empathy and kindness toward other people -* Being respectful of differing opinions, viewpoints, and experiences -* Giving and gracefully accepting constructive feedback -* Accepting responsibility and apologizing to those affected by our mistakes, +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience -* Focusing on what is best not just for us as individuals, but for the overall +- Focusing on what is best not just for us as individuals, but for the overall community Examples of unacceptable behavior include: -* The use of sexualized language or imagery, and sexual attention or advances of +- The use of sexualized language or imagery, and sexual attention or advances of any kind -* Trolling, insulting or derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or email address, +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or email address, without their explicit permission -* Other conduct which could reasonably be considered inappropriate in a +- Other conduct which could reasonably be considered inappropriate in a professional setting ## Enforcement Responsibilities @@ -59,9 +59,9 @@ representative at an online or offline event. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported to the community leaders responsible for enforcement at -[info at cobrowser.xyz]. -All complaints will be reviewed and investigated promptly and fairly. +reported to the community leaders responsible for enforcement at [info at +cobrowser.xyz]. All complaints will be reviewed and investigated promptly and +fairly. All community leaders are obligated to respect the privacy and security of the reporter of any incident. @@ -118,8 +118,8 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. -Community Impact Guidelines were inspired by -[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder][Mozilla CoC]. For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1e9fb6d..8280aa9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,8 @@ # 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. +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 @@ -16,26 +18,33 @@ First off, thank you for considering contributing to browser-use MCP Server! Thi ## Code of Conduct -We have adopted a Code of Conduct that we expect project participants to adhere to. Please read [the full text](CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated. +We have adopted a Code of Conduct that we expect project participants to adhere +to. Please read [the full text](CODE_OF_CONDUCT.md) 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` +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` + +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. +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 @@ -49,14 +58,19 @@ issue noting these corrections, and we'll batch them into larger updates. We use GitHub issues to track bugs. Before creating a bug report: -- Search existing [Issues](https://github.com/co-browser/browser-use-mcp-server/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 +- Search existing + [Issues](https://github.com/co-browser/browser-use-mcp-server/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. +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. +Enhancement suggestions are tracked through GitHub issues. Please use our +feature request template when suggesting enhancements. ### Pull Requests @@ -81,4 +95,5 @@ Enhancement suggestions are tracked through GitHub issues. Please use our featur ## License -By contributing to browser-use MCP Server, you agree that your contributions will be licensed under the MIT License. See [LICENSE](LICENSE) for details. +By contributing to browser-use MCP Server, you agree that your contributions +will be licensed under the MIT License. See [LICENSE](LICENSE) for details.