CONTRIBUTING.md•2.53 kB
# Contributing to Selenium MCP Server
First off, thank you for considering contributing to the Selenium MCP Server! It's people like you that make this project great. Your help is appreciated, and every contribution is valuable.
## How Can I Contribute?
There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests, or writing code which can be incorporated into the main project.
### Reporting Bugs
- **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/pshivapr/selenium-mcp/issues).
- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/pshivapr/selenium-mcp/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
### Suggesting Enhancements
- Open a new issue to discuss your enhancement. Clearly describe the proposed enhancement and its use case.
- Before submitting a pull request, it's best to discuss the proposed change in an issue to ensure it aligns with the project's goals.
### Pull Requests
- Fork the repository and create your branch from `main`.
- If you've added code that should be tested, add tests.
- Ensure the test suite passes.
- Make sure your code lints.
- Issue that pull request!
## Getting Started
1. **Fork** the repository on GitHub.
2. **Clone** your fork locally:
```bash
git clone https://github.com/your_username/selenium-mcp.git
```
3. **Navigate** to the project directory:
```bash
cd selenium-mcp
```
4. **Install** dependencies:
```bash
npm install
```
5. **Run** the development server:
```bash
npm run dev
```
## Making Changes
1. Create a new branch for your changes:
```bash
git checkout -b my-feature-branch
```
2. Make your changes to the source code in the `src` directory.
3. Before submitting, build the project to ensure everything compiles correctly:
```bash
npm run build
```
4. Commit your changes with a clear and descriptive commit message.
```bash
git commit -m "feat: Add new browser interaction tool"
```
5. Push your branch to your fork:
```bash
git push origin my-feature-branch
```
6. Open a pull request from your fork to the `main` branch of the original repository.
Thank you for your contribution!