Contributing
Issues and pull requests are welcome on the GitHub repository.
Repository layout
| Path | Contents |
|---|---|
packages/jp-local-gov-id | JS API |
packages/jp-local-gov-id-data | index.json + .bin.br (prefectures, per-pref, JLIX). CSV / uncompressed .bin are repo-only |
scripts/ | Excel → data generation |
site/ | This docs site |
docs/ | Internal specs |
Getting started
npm install
npm test
npm run build
Required gate before PRs
npm run ci:local # preferred (nektos/act + Docker)
npm run ci:local:fallback # when Docker is unavailable
Regenerate data (Excel → CSV / .bin for review → .bin.br + hybrid JLIX for npm):
npm run generate
Source Excel monitoring
Once a week we fetch the Ministry’s nationwide local-government-code Excel and compare its SHA-256 to resources/000925835.xlsx in this repo. A mismatch or fetch failure does not auto-update the Excel — it flags that an investigation is needed.
Loading…
Run the same check locally:
npm run check:source-hash
Docs site locally:
npm run dev:site
Guidance
- Bug fixes, docs, and tests are welcome
- Breaking API or data-format changes should start with an Issue
- See
docs/(especiallylogics.md,main.md,test-spec-63-search-ngrams.md) for contracts
License: MIT.