Skip to content

Commit 3e91034

Browse files
cablateclaude
andcommitted
Add community health files and improve docs
- Add CONTRIBUTING.md with bug report, feature request, dev setup, and PR process - Add SECURITY.md with supported versions and 48h acknowledgment contact - Update CHANGELOG.md with Keep a Changelog format header, [Unreleased] section, and v0.0.1 initial release entry - Update README.md Contributing section to link to CONTRIBUTING.md and add SECURITY.md link in Security section Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 9603109 commit 3e91034

File tree

4 files changed

+139
-1
lines changed

4 files changed

+139
-1
lines changed

CHANGELOG.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
# Changelog
22

3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
## [0.0.48]
11+
12+
- feat: batch keyword scanning for local rank tracker (#68)
13+
314
## 0.0.47
415

516
- feat: dual-sort reviews — merge relevant + newest for ~10 reviews per place (#64)
@@ -170,3 +181,19 @@
170181
- Enhanced error handling and logging
171182
- Added comprehensive tool descriptions for LLM integration
172183
- Updated to latest MCP SDK version
184+
185+
## [0.0.1] - 2025-02-22
186+
187+
### Added
188+
189+
- Initial release of mcp-google-map MCP server
190+
- `search_nearby` tool: search for places near a location by keyword, radius, open-now filter, and minimum rating
191+
- `get_place_details` tool: retrieve detailed information for a place by its Google Maps Place ID
192+
- `@googlemaps/google-maps-services-js` integration
193+
- `@modelcontextprotocol/sdk` integration
194+
- `GOOGLE_MAPS_API_KEY` environment variable support via `dotenv`
195+
- npm global install support (`@cablate/mcp-google-map`)
196+
197+
[Unreleased]: https://github.com/cablate/mcp-google-map/compare/v0.0.48...HEAD
198+
[0.0.48]: https://github.com/cablate/mcp-google-map/compare/v0.0.1...v0.0.48
199+
[0.0.1]: https://github.com/cablate/mcp-google-map/releases/tag/v0.0.1

CONTRIBUTING.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
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).

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -311,6 +311,8 @@ skills/
311311

312312
For enterprise security reviews, see [Security Assessment Clarifications](./SECURITY_ASSESSMENT.md) — a 23-item checklist covering licensing, data protection, credential management, tool contamination, and AI agent execution environment verification.
313313

314+
To report a vulnerability, see [SECURITY.md](SECURITY.md).
315+
314316
## Roadmap
315317

316318
### Recent Additions
@@ -359,7 +361,7 @@ MIT
359361

360362
## Contributing
361363

362-
Community participation and contributions are welcome!
364+
Community participation and contributions are welcome! Please read [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, coding guidelines, and the pull request process.
363365

364366
- Submit Issues: Report bugs or provide suggestions
365367
- Create Pull Requests: Submit code improvements

SECURITY.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
| Version | Supported |
6+
|---------|-----------|
7+
| 0.x (current) | Yes |
8+
9+
Only the latest release in the `0.x` line receives security fixes.
10+
11+
## Reporting a Vulnerability
12+
13+
**Please do not open a public GitHub issue for security vulnerabilities.**
14+
15+
Email the maintainer directly at **reahtuoo310109@gmail.com** with:
16+
17+
- A description of the vulnerability
18+
- Steps to reproduce or a proof-of-concept
19+
- The potential impact
20+
- Any suggested mitigations (optional)
21+
22+
You will receive an acknowledgment within **48 hours**. After triage, we will work with you on a coordinated disclosure timeline.
23+
24+
## Scope
25+
26+
The primary security concern for this project is the handling of the `GOOGLE_MAPS_API_KEY` environment variable. Never commit your API key to version control. Use `.env` files that are listed in `.gitignore`.
27+
28+
For a detailed security assessment, see [SECURITY_ASSESSMENT.md](./SECURITY_ASSESSMENT.md).

0 commit comments

Comments
 (0)