Skip to content

Commit 90e96c0

Browse files
michioswhashkode
authored andcommitted
added contribution docs
1 parent c998de8 commit 90e96c0

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

CONTRIBUTING.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Contributing to browser-use MCP Server
2+
3+
### Table of Contents
4+
5+
- [Code of Conduct](#code-of-conduct)
6+
- [How to Contribute](#how-to-contribute)
7+
- [Guidelines for Non-Code Contributions](#guidelines-for-non-code-contributions)
8+
- [Reporting Bugs](#reporting-bugs)
9+
- [Suggesting Enhancements](#suggesting-enhancements)
10+
- [Pull Requests](#pull-requests)
11+
12+
## Code of Conduct
13+
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.
14+
15+
## How to Contribute
16+
17+
### Guidelines for Non-Code Contributions
18+
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.
19+
20+
### Reporting Bugs
21+
22+
#### Before Submitting a Bug
23+
- Search existing [Issues](https://github.com/co-browser/browser-use-mcp-server/issues) to ensure it hasn't already been reported.
24+
25+
#### How to Submit a Good Bug Report
26+
- Open a new issue with a descriptive title.
27+
- Clearly describe the problem, including:
28+
- Exact reproduction steps.
29+
- Commands or actions taken.
30+
- Observed behavior and expected behavior.
31+
- Include code snippets, screenshots, or logs formatted using Markdown.
32+
- Confirm if the issue is reproducible and under what conditions it occurs.
33+
34+
### Suggesting Enhancements
35+
36+
#### Before Submitting an Enhancement
37+
- Search existing [Issues](https://github.com/co-browser/browser-use-mcp-server/issues) to avoid duplicates.
38+
39+
#### How to Submit a Good Enhancement Suggestion
40+
- Clearly and descriptively title your issue.
41+
- Provide a detailed explanation of the enhancement.
42+
- Describe current vs. desired behavior.
43+
- Explain why this enhancement benefits the project and its users.
44+
- Specify your OS and relevant software versions if applicable.
45+
46+
### Pull Requests
47+
- Pull requests undergo automated checks, including build and linting. Ensure these checks pass.
48+
- Ensure your PR addresses the following:
49+
- Clearly described purpose and benefits.
50+
- Consistent code style and formatting.
51+
- Clearly document commit messages, providing detailed context for substantial changes.
52+
- PRs focused solely on formatting without functional improvements will generally be rejected.
53+

0 commit comments

Comments
 (0)