Contributing Guide

Thank you for your interest in contributing to the PageSpeed Insights MCP Server! We welcome contributions from the community.

Development Setup

Clone the repository:

git clone https://github.com/ruslanlap/pagespeed-insights-mcp.git
cd pagespeed-insights-mcp

Install dependencies:
```
npm install
```
Configure Environment: Create a .env file or export the required variables:
```
export GOOGLE_API_KEY=your_test_key
```

Development Workflow

Running Locally

To run the server in development mode with hot-reloading:

npm run dev

This uses tsx to run the TypeScript code directly.

Building

To build the project for production:

npm run build

This compiles the TypeScript code to JavaScript in the dist/ directory.

Testing

We use Vitest for testing.

Run all tests:
```
npm test
```
Run tests with coverage:
```
npm run test:coverage
```

Please ensure that any new features or bug fixes are accompanied by appropriate tests.

Code Style

We use ESLint and Prettier to maintain code quality.

Lint code:
```
npm run lint
```
Fix linting issues:
```
npm run lint:fix
```
Format code:
```
npm run format
```

Submitting a Pull Request

Fork the repository.
Create a new branch for your feature or fix: git checkout -b feature/amazing-feature.
Commit your changes with clear messages.
Push to your fork.
Open a Pull Request against the master branch.

Release Process

This project uses Semantic Release to automate versioning and publishing. Ensure your commit messages follow the Conventional Commits specification (e.g., feat: add new tool, fix: handle api error).