GitHub Pages serves at /jsonPrism/ (case-sensitive, mirrors the repo name `poli0981/jsonPrism`). Our Vite `base` was set to `/jsonprism/` (lowercase), so index.html referenced `/jsonprism/assets/*.js` and every asset 404'd — the deployed page rendered blank. Rebase all GitHub URLs / Vite base / React Router basename to match the existing repo case `jsonPrism`. Renaming the repo to all-lowercase is the cleaner long-term fix, but that's a user-side action. GitHub Actions `macos-13` runners no longer pick up jobs (the macOS Intel build sat queued for >18 min, then was cancelled). Replace the two-entry matrix (macos-14 ARM + macos-13 Intel) with a single universal2 build on `macos-14` using `--target universal-apple-darwin`. The resulting `.app` / `.dmg` runs on both Apple Silicon and Intel. Storage keys, package name, Tauri identifier remain lowercase (`jsonprism`) — unaffected. Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
4.3 KiB
Contributing to JSONPrism
Thanks for considering a contribution! JSONPrism is an open-source project under Apache License 2.0.
Quick start
git clone https://github.com/poli0981/jsonPrism.git
cd jsonprism
npm install
npm run dev
Open http://localhost:5173.
Before opening a PR
-
Run the checks locally:
npm run format npm run lint npm run typecheck npm run buildCI runs all four. If any fails, your PR can't be merged.
-
Match the project style. Read
CLAUDE.mdfor non-negotiable conventions (converter shape, error handling, i18n requirements). -
Keep PRs focused. One feature or one fix per PR. Refactors as separate PRs.
-
Write a clear PR description: what changed, why, screenshots if UI.
Ways to contribute
🐛 Bug reports
Use the Bug Report template. Include:
- Browser + OS
- Steps to reproduce
- Sample JSON that triggers the bug (minimal, please)
- Expected vs actual output
💡 Feature requests
Use the Feature Request template. We prioritize features that:
- Fit the "one JSON → many formats" core mission
- Don't require server-side processing (we're client-only by design)
- Have a clear use case from a real workflow
🌍 Translations
Currently bundled: English, Tiếng Việt, 日本語, 简体中文. Non-English locales are AI-generated and not professionally reviewed — see DISCLAIMER.md. Native-speaker corrections are very welcome.
To add a new language:
- Copy
src/i18n/locales/en.jsontosrc/i18n/locales/<your-locale>.json - Translate every value
- Register in
src/i18n/index.ts - Add to the
supportedLngsarray - Add the language to
LanguageSwitcher.tsx - Open a PR
➕ Adding a new converter
See the "Adding a new converter — checklist" section in CLAUDE.md.
Briefly:
- New file
src/converters/myformat.tsimplementingConverter<TOptions> - Register in
registry.tsandtypes.ts - Add i18n labels (EN + VI minimum)
- Update README format tables
- Mark roadmap entry done
Commit messages
We follow a relaxed version of Conventional Commits:
feat(converter): add TOML converter with smol-toml
fix(csv): escape pipes in cell values
docs: clarify Tauri build steps
chore(deps): bump react to 19.1
Prefixes: feat, fix, docs, refactor, test, chore, style.
Auto-ignored contributions
To keep the maintainer's review queue manageable, the following are closed without review:
- PRs with suspicious code. If a diff looks like obfuscated/minified code, hidden network calls, or subtly tampered third-party files, it will be flagged. If CodeQL or Dependabot also flag it, the contributor will be banned without exception. The maintainer may also verify suspect sections by hand.
- PRs / issues posting unknown / random links (especially shortened URLs to "demos", "fixes", etc. with no clear source).
- Behavior / language violating GitHub's policy — harassment, hate speech, doxxing, NSFW content, etc.
- Off-topic preamble, e.g. "Chào buổi sáng, hôm nay là 1 ngày trời đẹp…" or any greeting/filler that doesn't immediately address the issue. Get to the point: what's wrong, what's the expected behavior, what reproduces it.
- PRs without a meaningful description or test plan. See the PR template — sections marked required are required.
These rules exist because this is a one-person + AI-assisted project (see DISCLAIMER.md); time spent triaging low-effort contributions takes away from real work.
Code of Conduct
This project adopts the Contributor Covenant v2.1. Be kind. Assume good faith. Disagreements about technical choices are fine; personal attacks and harassment are not.
Reports to the maintainer via the private Security Advisory flow for sensitive matters, or a private GitHub Discussion otherwise.
License
By contributing, you agree your contributions will be licensed under Apache License 2.0.