ISO8583Studio
Pro Download Studio
Open source · AGPL v3

How to Contribute

ISO8583Studio is AGPL v3-licensed and built in the open. Bug fixes, new tools, simulator work and docs are all welcome.

LanguageKotlin MultiplatformBuild./gradlewJDK11+ (17 LTS)
Table of contents
01Prerequisites02Development setup03Code style04Submitting changes05Reporting issues06Where to start
01

Prerequisites (Kotlin Multiplatform)

ToolVersionPurpose
JDK11+ (17 LTS recommended)Compiles Kotlin and runs Compose Desktop.
Gitany recentClone, branch, PR.
IntelliJ IDEACommunity is fineRecommended IDE — opens the Gradle project directly with Kotlin/Compose support.
Gradlebundled wrapperNo separate install — use ./gradlew.
02

Development setup

clone, build, run
git clone https://github.com/hpkaushik121/Iso8583studio.gitcd Iso8583studio./gradlew build     # compile everything + run tests./gradlew run       # launch the desktop app./gradlew test      # tests only

Project layout

  • composeApp/ — The Compose Desktop application — UI screens, simulator services, HSM/payShield engine (src/desktopMain/kotlin).
  • iso-core-lib/ — Core ISO 8583 message library.
  • cryptocalc/ — Cryptography calculators module.
  • docs/ — This website.
03

Code style

Follow standard Kotlin conventions:

naming
class GatewayConfiguration        // classes: PascalCasefun processTransaction()          // functions: camelCaseconst val DEFAULT_TIMEOUT = 30    // constants: UPPER_SNAKE_CASEval connectionManager = ...       // variables: camelCase
04

Submitting changes

  1. Fork the repository on GitHub.
  2. Branchgit checkout -b feature/new-feature
  3. Build & test — make your change and run the full build. ./gradlew build
  4. Commit with a descriptive message. git commit -m "Add REST API support"
  5. Push & open a Pull Request — then open the PR against main. git push origin feature/new-feature
05

Reporting issues

Open a GitHub issue and include:

  • Environment — OS, Java version, app version.
  • Steps to reproduce — exact clicks/config that trigger it.
  • Expected vs actual behaviour — plus logs, configuration files or screenshots.
06

Where to start

Not sure where to start? Questions and ideas are welcome in Issues, or reach us via the contact page.

Good first change Open a pull requestFork, branch, build, and open the PR against main. Small fixes land fastest.Open the repositoryQuestions & ideas IssuesAsk before you build if a change is large, or float an idea for a new tool.Open an issueSomething broken IssuesReport a bug with environment, steps and logs, or request a feature.Open an issue
AGPL v3 · JDK 17+ · Gradle wrapper includedContact us