2.7 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 and Tiếng Việt. 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.
Code of Conduct
Be kind. Assume good faith. Disagreements about technical choices are fine; personal attacks are not.
Reports to the maintainer via GitHub (DM or email on profile).
License
By contributing, you agree your contributions will be licensed under Apache License 2.0.