Skip to content

Commit 8f06113

Browse files
cyphercodesclaude
cyphercodes
and
claude
committed
chore: add OSS templates, security policy, dependabot, changelog
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 0694702 commit 8f06113

7 files changed

Lines changed: 178 additions & 2 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Bug report
3+
about: Report a problem with location-picker
4+
title: '[Bug] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Describe the bug
10+
11+
A clear and concise description of what the bug is.
12+
13+
## Steps to reproduce
14+
15+
1. ...
16+
2. ...
17+
3. ...
18+
19+
A minimal reproduction (CodeSandbox, StackBlitz, or a small repo) is hugely appreciated.
20+
21+
## Expected behavior
22+
23+
What did you expect to happen?
24+
25+
## Actual behavior
26+
27+
What actually happened? Include any error messages or stack traces.
28+
29+
## Environment
30+
31+
- `location-picker` version:
32+
- Browser + version (e.g. Chrome 124, Firefox 126, Safari 17):
33+
- Node.js version (if relevant):
34+
- Google Maps JS API version / `libraries=` used:
35+
- OS:
36+
37+
## Additional context
38+
39+
Screenshots, console logs, or anything else that might help.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea or improvement for location-picker
4+
title: '[Feature] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Problem
10+
11+
What problem are you trying to solve? Is your feature request related to a pain point you've experienced? Please describe.
12+
13+
## Proposed solution
14+
15+
Describe the solution you'd like. Include API sketches, example usage, or mockups if helpful.
16+
17+
## Alternatives considered
18+
19+
Describe any alternative solutions or workarounds you've considered.
20+
21+
## Additional context
22+
23+
Add any other context, links, or references about the feature request here.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
## Summary
2+
3+
<!-- What does this PR do? Why is it needed? -->
4+
5+
## Type of change
6+
7+
- [ ] fix (bug fix, non-breaking)
8+
- [ ] feat (new feature, non-breaking)
9+
- [ ] chore (tooling, deps, CI, build)
10+
- [ ] docs (documentation only)
11+
- [ ] refactor / perf
12+
- [ ] BREAKING CHANGE
13+
14+
## Checklist
15+
16+
- [ ] Tests added / updated and passing (`npm test`)
17+
- [ ] Lint passes (`npm run lint`)
18+
- [ ] Typecheck passes (`npm run typecheck`)
19+
- [ ] Documentation updated where relevant (README, CHANGELOG, JSDoc)
20+
- [ ] No breaking changes — or breaking changes are clearly documented in the PR description and CHANGELOG
21+
22+
## Related issues
23+
24+
<!-- e.g. Closes #123 -->

‎.github/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+
Security updates are provided for the following versions of `location-picker`:
6+
7+
| Version | Supported |
8+
| ------- | ------------------ |
9+
| 2.x | :white_check_mark: |
10+
| < 2.0 | :x: |
11+
12+
## Reporting a Vulnerability
13+
14+
Please **do not** report security vulnerabilities through public GitHub issues.
15+
16+
Instead, report them privately by emailing **rayansalhab@hotmail.com** with:
17+
18+
- A description of the issue and its potential impact
19+
- Steps to reproduce (a minimal proof of concept is ideal)
20+
- Any relevant version / environment information
21+
22+
### Response Time
23+
24+
- You should receive an initial acknowledgement within **72 hours**.
25+
- We aim to provide a status update (triage outcome, fix timeline, or request for more info) within **7 days**.
26+
- Once a fix is ready, we will coordinate a disclosure date with you before publishing.
27+
28+
Thank you for helping keep `location-picker` and its users safe.

‎.github/dependabot.yml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: npm
4+
directory: '/'
5+
schedule:
6+
interval: weekly
7+
open-pull-requests-limit: 10
8+
labels:
9+
- dependencies
10+
- npm
11+
commit-message:
12+
prefix: chore
13+
include: scope
14+
15+
- package-ecosystem: github-actions
16+
directory: '/'
17+
schedule:
18+
interval: weekly
19+
open-pull-requests-limit: 5
20+
labels:
21+
- dependencies
22+
- github-actions
23+
commit-message:
24+
prefix: chore
25+
include: scope

‎CHANGELOG.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Changelog
2+
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.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [2.0.0] - 2026-04-12
9+
10+
### Added
11+
12+
- `destroy()` method to cleanly tear down a picker instance and its listeners.
13+
- `onLocationChange` option — callback fired whenever the selected location changes.
14+
- `useAdvancedMarker` option for opting into Google Maps' Advanced Markers (`AdvancedMarkerElement`).
15+
- Named export: `import { LocationPicker } from 'location-picker'`.
16+
17+
### Changed
18+
19+
- **BREAKING:** `setCurrentPosition()` now returns a `Promise` that resolves once the browser geolocation lookup completes (or rejects on error / denial). Previously it was fire-and-forget.
20+
- Replaced the deprecated `@types/googlemaps` with the official `@types/google.maps`.
21+
- Toolchain modernized: TypeScript 5, ESLint 9 (flat config), Rollup 4, Vitest for tests.
22+
23+
### Removed
24+
25+
- **BREAKING:** Dropped the UMD bundle. The package now ships ESM (`dist/index.mjs`) and CJS (`dist/index.cjs`) only.
26+
27+
## [1.0.x]
28+
29+
Earlier 1.x releases — see the [git history](https://github.com/cyphercodes/location-picker/commits/master) for details.

‎package.json‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,21 @@
44
"description": "An open source location picker plugin using Google Maps v3 that works with all JavaScript flavors!",
55
"keywords": [
66
"locationpicker",
7+
"location-picker",
78
"google-maps",
9+
"google-maps-api",
10+
"map",
11+
"marker",
12+
"geolocation",
813
"javascript",
914
"javascript-plugin",
1015
"typescript",
1116
"esm"
1217
],
13-
"homepage": "https://github.com/cyphercodes/location-picker",
18+
"homepage": "https://github.com/cyphercodes/location-picker#readme",
19+
"bugs": {
20+
"url": "https://github.com/cyphercodes/location-picker/issues"
21+
},
1422
"type": "module",
1523
"main": "dist/index.cjs",
1624
"module": "dist/index.mjs",
@@ -33,7 +41,7 @@
3341
"author": "Rayan Salhab <rayansalhab@hotmail.com>",
3442
"repository": {
3543
"type": "git",
36-
"url": "https://github.com/cyphercodes/location-picker.git"
44+
"url": "git+https://github.com/cyphercodes/location-picker.git"
3745
},
3846
"license": "MIT",
3947
"engines": {

0 commit comments

Comments
 (0)