Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
24 lines (18 loc) · 838 Bytes

CONTRIBUTING.md

File metadata and controls

24 lines (18 loc) · 838 Bytes
Raw

Contributing

Thanks for helping improve xslint-jetbrains.

Build and test

Requires JDK 21 and Node.js. The Gradle wrapper pins everything else.

./gradlew build            # compile, test, and assemble the plugin
./gradlew runIde           # try it in a sandbox IDE
./gradlew detekt           # Kotlin static analysis
./gradlew verifyPlugin     # the JetBrains Plugin Verifier

Guidelines

  • Keep the plugin a thin adapter. The linting lives in xslint and the server in xslint-lsp; logic belongs upstream, not here.
  • Every source file carries an SPDX header — run reuse lint to check.
  • Open a pull request; CI (build, coverage, detekt, plugin verifier, REUSE, and the meta-linters) must be green before it merges.