Thank you for your interest in contributing. To begin, please follow the steps below.
Please open an issue if you have found a bug, or you have any idea how to improve experience with kebs in IntelliJ IDEA.
If you have no ideas what to contribute, you can check project's issue tracker.
Fork the repository, clone project using git, open it in IntelliJ and import as sbt project.
Please use Java SDK 17. Project provides sdkman env file so you can easily use
proper version with sdk env (see https://sdkman.io/usage#env).
Project uses sbt-idea-plugin to define runtime configuration "kebs-intellij". Using it you can run a new instance of IntelliJ with actual plugin code.
All features of the plugin are tested with unit tests. Please remember to write tests to the code you want to contribute.
You can use sbt command to format the code:
sbt fmt
Once you have a code that closes an issue (does not matter if opened by you or someone else), put the changes on a branch and create a pull request. Wait for a review and merge it into the main branch after approve (before that you might be requested for changes that improve your contribution and make it follow existing conventions in the code base).
If you get stuck, please consider opening a pull request with your incomplete work, and ask for help (please prefix
the pull request with [WIP] ). In addition, you can put a comment on the original issue, pointing people to your own fork.