|
| 1 | +# Contributing to mcp-google-map |
| 2 | + |
| 3 | +Thank you for your interest in contributing. This guide covers how to report bugs, suggest features, set up a dev environment, and submit pull requests. |
| 4 | + |
| 5 | +## Bug Reports |
| 6 | + |
| 7 | +Open an issue at [GitHub Issues](https://github.com/cablate/mcp-google-map/issues) and include: |
| 8 | + |
| 9 | +- A clear title and description |
| 10 | +- Steps to reproduce |
| 11 | +- Expected vs actual behavior |
| 12 | +- Node.js version and OS |
| 13 | +- Any relevant logs or error output |
| 14 | + |
| 15 | +## Feature Suggestions |
| 16 | + |
| 17 | +Open an issue with the label `enhancement`. Describe: |
| 18 | + |
| 19 | +- The problem you are trying to solve |
| 20 | +- Your proposed solution |
| 21 | +- Any alternatives you considered |
| 22 | + |
| 23 | +## Development Setup |
| 24 | + |
| 25 | +**Prerequisites:** Node.js >= 18, npm |
| 26 | + |
| 27 | +```bash |
| 28 | +# Clone the repository |
| 29 | +git clone https://github.com/cablate/mcp-google-map.git |
| 30 | +cd mcp-google-map |
| 31 | + |
| 32 | +# Install dependencies |
| 33 | +npm install |
| 34 | + |
| 35 | +# Build |
| 36 | +npm run build |
| 37 | +``` |
| 38 | + |
| 39 | +Copy `.env.example` to `.env` and fill in `GOOGLE_MAPS_API_KEY` before running locally. |
| 40 | + |
| 41 | +### Running Tests |
| 42 | + |
| 43 | +```bash |
| 44 | +# Smoke tests (no API key required) |
| 45 | +npm test |
| 46 | + |
| 47 | +# Full E2E tests (requires GOOGLE_MAPS_API_KEY) |
| 48 | +npm run test:e2e |
| 49 | +``` |
| 50 | + |
| 51 | +## Pull Request Process |
| 52 | + |
| 53 | +1. Fork the repository and create a branch from `main`: |
| 54 | + ```bash |
| 55 | + git checkout -b feat/your-feature-name |
| 56 | + ``` |
| 57 | +2. Make your changes and ensure the build and tests pass: |
| 58 | + ```bash |
| 59 | + npm run build |
| 60 | + npm test |
| 61 | + ``` |
| 62 | +3. Commit using a clear message in the imperative mood (e.g., `feat: add place autocomplete tool`). |
| 63 | +4. Push your branch and open a pull request against `main`. |
| 64 | +5. Fill in the PR description, link any related issues, and wait for a review. |
| 65 | +6. Once approved and all checks pass, the maintainer will merge. |
| 66 | + |
| 67 | +## Code Style |
| 68 | + |
| 69 | +- TypeScript strict mode is expected. |
| 70 | +- Keep tool definitions under `src/tools/maps/`. |
| 71 | +- Use `camelCase` for variables/functions, `PascalCase` for classes/interfaces, `UPPER_SNAKE_CASE` for constants. |
| 72 | +- Match the existing file and naming conventions. |
| 73 | +- Run `npm run build` before committing — the build must pass cleanly. |
| 74 | + |
| 75 | +## Questions? |
| 76 | + |
| 77 | +Reach out at [reahtuoo310109@gmail.com](mailto:reahtuoo310109@gmail.com) or open a GitHub Discussion. |
| 78 | + |
| 79 | +## License |
| 80 | + |
| 81 | +By contributing, you agree that your contributions will be licensed under the [MIT License](LICENSE). |
0 commit comments