Before proceeding please read section "Setting up the project" if you haven't yet.
It's strongly recommended to get familiar with IntelliJ Platform SDK documentation.
It contains most of the information required to develop IntelliJ-based plugins.
In case of any questions you are welcome on our discord channel, we will be glad to answer your questions.
- How to contribute to IntelliJ Scala plugin (includes YouTube video)
- Building IntelliJ IDEA plugins in Scala by Igal Tabachnik: Scala in the City Conference (YouTube video)
- Up For Grabs contains a list of easy-to start YouTrack tickets
- Glossary of IntelliJ Platform
- Explore the IntelliJ Platform API
- PSI Viewer is an essential tool to dig into the structure of a source code.
- Useful links in IntelliJ docs
- Make sure your modifications are covered by tests
- Make sure you have a YouTrack issue number before you start working
- Every commit message should reference the YouTrack issue number in format
#SCL-XXXXX- Place primary issue number in the end of the first message line
- If you have multiple equally-important related issues place them in the end of the first message line
- If you have some non-primary, but related issues you can reference them in the commit message body.
- In the last commit of a series which fixes an issue, append
#SCL-XXXXX fixedto the end of the first message line issue which is fixed. This will close the YouTrack issues automatically when the change is merged into main branch.
- Use short subsystem prefix in your commits. We don't have a fixed set of such subsystems. Use common sense and, at least, the same prefix for a related group of commits
- Try to provide any extra helpful information in the commit message body
- Try to keep commits focused to help reviewers
[sbt shell] delete SigIntAction #SCL-14369 #SCL-16727 #SCL-12030
It's not actual after #SCL-15583: we now have a common shortcut for "Stop" action (see tooltip over the "stop" button)
[annotator] dont annotate ConstructorInvocation in definitions (#SCL-20540, #SCL-20737) fixed
also related #SCL-20185
Happy coding !
Please get familiar with docs Testing Overview
For most of the subsystems there are already some tests written
and all you need is to find an appropriate test class/base test class and add a new test case/test class.
However, quite frequently finding the suitable test class might be quite tricky.
In most cases there is no 1-1 correspondence between class name and test class names.
There are multiple ways how to find the correct test suite:
- Use "Go To Class" or "Go To File" action in combination with fuzzy search for the subsystem.
For example, if you search "ScalaDocFormatTest" you will findScalaDocFormatterTest.scalaandScalaDocFormatterTest2.scala - Search for the edited test files in similar changes.
When you make changes in some files you can browse commit history of the files using git blame or file history. In that commit history you might see related test files. One of them might be the one you need. - If you struggle to find any suitable test you can ask for help in our discord channel