Files
jsonPrism/CONTRIBUTING.md
T
2026-05-13 09:43:37 +07:00

2.7 KiB
Raw Blame History

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

  1. Run the checks locally:

    npm run format
    npm run lint
    npm run typecheck
    npm run build
    

    CI runs all four. If any fails, your PR can't be merged.

  2. Match the project style. Read CLAUDE.md for non-negotiable conventions (converter shape, error handling, i18n requirements).

  3. Keep PRs focused. One feature or one fix per PR. Refactors as separate PRs.

  4. 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:

  1. Copy src/i18n/locales/en.json to src/i18n/locales/<your-locale>.json
  2. Translate every value
  3. Register in src/i18n/index.ts
  4. Add to the supportedLngs array
  5. Add the language to LanguageSwitcher.tsx
  6. Open a PR

➕ Adding a new converter

See the "Adding a new converter — checklist" section in CLAUDE.md.

Briefly:

  1. New file src/converters/myformat.ts implementing Converter<TOptions>
  2. Register in registry.ts and types.ts
  3. Add i18n labels (EN + VI minimum)
  4. Update README format tables
  5. 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.