Repository navigation
Conversation
gtkrish85
marked this pull request as ready for review
November 15, 2026 15:09
Author
milamberspace
left a comment
Contributor
There was a problem hiding this comment.
Thanks for picking this up, the removed steps indeed no longer exist in current IntelliJ IDEA versions, and the change is well scoped.
Requested change
CONTRIBUTING.md(section IntelliJ IDEA, lines 39-43) contains exactly the same outdated steps (Create separate module per source set,Use default gradle wrapper,File already exists,Delete Existing Project and Import). Many new contributors land there first, so after this PR the two documents would contradict each other. Could you apply the same update there?
Suggestions (non-blocking)
- "You require IntelliJ 2018.3.1 or newer" (
building.xml:54andCONTRIBUTING.md:37) is misleading as well: the build needs JDK 17 and a recent Gradle, which a 2018 IntelliJ cannot handle. Consider dropping the version or pointing to a recent release. - The most common pitfall nowadays is the Gradle JVM: mentioning that Settings → Build, Execution, Deployment → Build Tools → Gradle → Gradle JVM must point to JDK 17+ would probably help more than "just wait".
| <li>Make sure "Use default gradle wrapper" is selected</li> | ||
| <li>In the "File already exists" dialogue, choose "Yes" to overwrite</li> | ||
| <li>In the "Open Project" dialogue, choose "Delete Existing Project and Import"</li> | ||
| <li>IntelliJ IDEA will import the Gradle project automatically — just wait for the Gradle sync to finish</li> |
Contributor
There was a problem hiding this comment.
Small wording suggestion (no other page in xdocs uses an em dash, and "just" can be dropped):
Suggested change
| <li>IntelliJ IDEA will import the Gradle project automatically — just wait for the Gradle sync to finish</li> | |
| <li>IntelliJ IDEA imports the Gradle project automatically; wait for the Gradle sync to finish</li> | |
| <li>If the sync fails, make sure the Gradle JVM (Settings, Build Tools, Gradle) points to JDK 17 or newer</li> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Fixes #6285. Updates the IntelliJ IDEA import instructions in xdocs/building.xml: removes steps 2–5, which describe dialogs that no longer exist in current IntelliJ versions, and notes that IntelliJ imports the Gradle project automatically once you open build.gradle.kts.
Motivation and Context
The current instructions cost new contributors time — the issue reporter lost about an hour following steps that don't exist anymore. This brings the docs in line with how current IntelliJ versions actually import Gradle projects.
How Has This Been Tested?
Screenshots (if appropriate):
Not applicable — docs-only change, no UI affected.
Types of changes
Checklist: