Skip to content

Improve “IntelliJ – Using JUnit” tutorial for clarity, completeness, and student utility #162

Description

@arshinsikka

The “IntelliJ – Using JUnit” tutorial is functional, but there’s room to make it clearer and more complete for students who are new to IntelliJ, Gradle, and JUnit.

Some proposed improvements:

  • Add an explicit build.gradle snippet with the correct testImplementation dependency and useJUnitPlatform() configuration so students can copy-paste and get started.
  • Include a quick check for setting the Project SDK and language level in File → Project Structure to avoid compilation errors.
  • Clarify test folder/package structure and show how to Mark Directory as → Test Sources Root if it’s not already set.
  • Explain the “Run tests using” (Gradle vs IntelliJ) option in Preferences and when to use each.
  • Add a short “Debugging Tests” section showing how to set breakpoints, debug from the gutter, and inspect variables.
  • Add a “Run with Coverage” section with steps and screenshots of coverage results.
  • Standardise shortcut formatting (Ctrl/⌘, Alt/Option) for cross-platform clarity.
  • Annotate screenshots with arrows/callouts to make UI elements easier to spot.
  • Include a minimal example Java class + test to demonstrate the full workflow.
  • Expand the Run Configurations section to cover “All Tests in Module” vs “Single Class/Package” and basic filtering.
  • Add a short troubleshooting FAQ for common beginner errors (e.g., “No tests found”, missing dependencies).
  • Use boxed notes for important tips and warnings, and check all links for accuracy.

Opening a PR to incorporate these improvements now.


Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions