Add Code of Conduct and update contributing guidelines

hashkode · hashkode · commit c2689d7fde51 · 2025-03-26T22:22:22.000+01:00
- 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.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md 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. 
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md 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. 
diff --git a/.github/pull_request_template.md 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)
diff --git a/CODE_OF_CONDUCT.md 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
@@ -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.
