Skip to content

doc: Update README with uni-test documentation#311

Merged
xerial merged 1 commit intomainfrom
docs/update-readme-unitest
Jan 13, 2026
Merged

doc: Update README with uni-test documentation#311
xerial merged 1 commit intomainfrom
docs/update-readme-unitest

Conversation

@xerial
Copy link
Copy Markdown
Member

@xerial xerial commented Jan 13, 2026

Summary

  • Add uni-test as a separate module in the overview section
  • Document cross-platform support (JVM, Scala.js, Scala Native)
  • Document IntelliJ IDEA integration via JUnit Platform
  • Add uni-test dependency and testFramework configuration example

Changes

  • Moved testing framework from uni description to its own uni-test section
  • Added dependency example with % Test scope
  • Added testFrameworks configuration line

🤖 Generated with Claude Code

@github-actions github-actions Bot added the doc Improvements or additions to documentation label Jan 13, 2026
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @xerial, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the documentation for the uni-test module within the README.md file. It aims to provide a clearer and more comprehensive overview of the testing framework's capabilities, including its cross-platform compatibility and IDE integration, alongside practical configuration examples for users.

Highlights

  • Dedicated uni-test Documentation: The uni-test module now has its own distinct section in the README.md, separating it from the core uni module for improved clarity.
  • Cross-Platform Support Details: The documentation for uni-test explicitly outlines its support for JVM, Scala.js, and Scala Native environments.
  • IntelliJ IDEA Integration: The README.md now highlights uni-test's integration with IntelliJ IDEA via the JUnit Platform, enabling direct test execution from the IDE.
  • Dependency and Configuration Examples: Clear code examples have been added to the README.md for including the uni-test dependency and configuring the testFrameworks.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

- Add uni-test as a separate module in the overview
- Document cross-platform support (JVM, Scala.js, Scala Native)
- Document IntelliJ IDEA integration via JUnit Platform
- Add uni-test dependency and testFramework configuration

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@xerial xerial force-pushed the docs/update-readme-unitest branch from 679f25a to fefa11b Compare January 13, 2026 00:47
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the README to properly document the uni-test module. The changes include creating a dedicated section for uni-test in the overview and updating the build.sbt usage example. The changes are a good improvement. I've suggested one change to the build.sbt example to make it clearer for users how to add dependencies for individual modules, which will improve the user experience.

@xerial xerial enabled auto-merge (squash) January 13, 2026 00:49
@xerial xerial merged commit 715e5fb into main Jan 13, 2026
10 checks passed
@xerial xerial deleted the docs/update-readme-unitest branch January 13, 2026 00:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant