Skip to content

Commit 2cfdaa1

Browse files
michioswmichiosw
authored
Merge pull request #16 from co-browser/chore/add-contribution-docs
chore : add contribution docs
2 parents 3258af5 + 5f30102 commit 2cfdaa1

File tree

6 files changed

+332
-0
lines changed

6 files changed

+332
-0
lines changed

Diff for: ‎.github/ISSUE_TEMPLATE/bug_report.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve
4+
title: "[BUG] "
5+
labels: bug
6+
assignees: ""
7+
---
8+
9+
**Describe the bug** A clear and concise description of what the bug is.
10+
11+
**To Reproduce** Steps to reproduce the behavior:
12+
13+
1. Go to '...'
14+
2. Click on '....'
15+
3. Scroll down to '....'
16+
4. See error
17+
18+
**Expected behavior** A clear and concise description of what you expected to
19+
happen.
20+
21+
**Screenshots** If applicable, add screenshots to help explain your problem.
22+
23+
**Environment (please complete the following information):**
24+
25+
- OS: [e.g. macOS, Windows, Linux]
26+
- Version [e.g. 1.2.3]
27+
- Client [if applicable]
28+
- Version [e.g. 1.2.3]
29+
30+
**Additional context** Add any other context about the problem here.

Diff for: ‎.github/ISSUE_TEMPLATE/feature_request.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
title: "[FEATURE] "
5+
labels: enhancement
6+
assignees: ""
7+
---
8+
9+
**Is your feature request related to a problem? Please describe.** A clear and
10+
concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
12+
**Describe the solution you'd like** A clear and concise description of what you
13+
want to happen.
14+
15+
**Describe alternatives you've considered** A clear and concise description of
16+
any alternative solutions or features you've considered.
17+
18+
**Additional context** Add any other context or screenshots about the feature
19+
request here.

Diff for: ‎.github/pull_request_template.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## Description
2+
3+
Please include a summary of the changes and which issue is fixed. Please also
4+
include relevant motivation and context.
5+
6+
Fixes # (issue)
7+
8+
## Type of change
9+
10+
Please delete options that are not relevant.
11+
12+
- [ ] Bug fix (non-breaking change which fixes an issue)
13+
- [ ] New feature (non-breaking change which adds functionality)
14+
- [ ] Breaking change (fix or feature that would cause existing functionality to
15+
not work as expected)
16+
- [ ] Documentation update
17+
18+
## How Has This Been Tested?
19+
20+
Please describe the tests that you ran to verify your changes. Provide
21+
instructions so we can reproduce.
22+
23+
## Checklist:
24+
25+
- [ ] My code follows the style guidelines of this project
26+
- [ ] I have performed a self-review of my code
27+
- [ ] I have commented my code, particularly in hard-to-understand areas
28+
- [ ] I have made corresponding changes to the documentation
29+
- [ ] My changes generate no new warnings
30+
- [ ] I have added tests that prove my fix is effective or that my feature works
31+
- [ ] New and existing unit tests pass locally with my changes (if applicable)

Diff for: ‎CODE_OF_CONDUCT.md

+132
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official email address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at [info at
63+
cobrowser.xyz]. All complaints will be reviewed and investigated promptly and
64+
fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series of
86+
actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or permanent
93+
ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within the
113+
community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126+
[https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130+
[Mozilla CoC]: https://github.com/mozilla/diversity
131+
[FAQ]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations

Diff for: ‎CONTRIBUTING.md

+99
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
# Contributing to browser-use MCP Server
2+
3+
First off, thank you for considering contributing to browser-use MCP Server!
4+
This project is released under the MIT License, which means your contributions
5+
will also be covered under the same permissive license.
6+
7+
### Table of Contents
8+
9+
- [Code of Conduct](#code-of-conduct)
10+
- [Getting Started](#getting-started)
11+
- [How to Contribute](#how-to-contribute)
12+
- [Guidelines for Non-Code Contributions](#guidelines-for-non-code-contributions)
13+
- [Reporting Bugs](#reporting-bugs)
14+
- [Suggesting Enhancements](#suggesting-enhancements)
15+
- [Pull Requests](#pull-requests)
16+
- [Development Process](#development-process)
17+
- [License](#license)
18+
19+
## Code of Conduct
20+
21+
We have adopted a Code of Conduct that we expect project participants to adhere
22+
to. Please read [the full text](CODE_OF_CONDUCT.md) so that you can understand
23+
what actions will and will not be tolerated.
24+
25+
## Getting Started
26+
27+
### Fork-based workflow (recommended as a playground)
28+
29+
1. Fork the repository
30+
2. Clone your fork:
31+
`git clone https://github.com/your-username/browser-use-mcp-server.git`
32+
3. Create a new branch: `git checkout -b feature/your-feature-name`
33+
4. Make your changes
34+
5. Push to your fork: `git push origin feature/your-feature-name`
35+
6. Open a Pull Request
36+
37+
### Direct repository workflow (for contributors)
38+
39+
1. Clone the repository directly:
40+
`git clone https://github.com/co-browser/browser-use-mcp-server.git`
41+
2. Create a new branch: `git checkout -b feature/your-feature-name`
42+
3. Make your changes
43+
4. Push to the repository: `git push origin feature/your-feature-name`
44+
5. Open a Pull Request
45+
46+
If you're interested in being contributor, please reach out to the maintainers
47+
after making a few successful contributions via issues and pull requests.
48+
49+
## How to Contribute
50+
51+
### Guidelines for Non-Code Contributions
52+
53+
We appreciate your attention to detail. However, minor fixes like typos or
54+
grammar corrections should not be submitted individually. Instead, create an
55+
issue noting these corrections, and we'll batch them into larger updates.
56+
57+
### Reporting Bugs
58+
59+
We use GitHub issues to track bugs. Before creating a bug report:
60+
61+
- Search existing
62+
[Issues](https://github.com/co-browser/browser-use-mcp-server/issues) to
63+
ensure it hasn't already been reported
64+
- If you find a closed issue that seems to address your problem, open a new
65+
issue and include a link to the original
66+
67+
When submitting a bug report, please use our bug report template and include as
68+
much detail as possible.
69+
70+
### Suggesting Enhancements
71+
72+
Enhancement suggestions are tracked through GitHub issues. Please use our
73+
feature request template when suggesting enhancements.
74+
75+
### Pull Requests
76+
77+
- Follow our pull request template
78+
- Include screenshots and animated GIFs in your pull request whenever possible
79+
- Follow our coding conventions and style guidelines
80+
- Write meaningful commit messages
81+
- Update documentation as needed
82+
- Add tests for new features
83+
- Pull requests undergo automated checks, including build and linting
84+
85+
## Development Process
86+
87+
1. Pick an issue to work on or create a new one
88+
2. Comment on the issue to let others know you're working on it
89+
3. Create a branch with a descriptive name
90+
4. Write your code following our style guidelines
91+
5. Add tests for new functionality
92+
6. Update documentation as needed
93+
7. Submit a pull request
94+
8. Respond to code review feedback
95+
96+
## License
97+
98+
By contributing to browser-use MCP Server, you agree that your contributions
99+
will be licensed under the MIT License. See [LICENSE](LICENSE) for details.

Diff for: ‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 cobrowser.xyz
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)