Skip to content

Conversation

olganaumenko
Copy link
Collaborator

Description

  • Product name was changed: UTBot Java → UnitTestBot.
  • A key product feature ("precise code analysis") was added to a general description.
  • System requirements moved to a separate file SystemRequirements.md.
  • Some wordings were changed for more congruency.

NOTE: it would be nice to update the name of the workflow UTBot Java: build and run tests for consistency. The badge name has been already updated (UTBot Java → UnitTestBot).

Type of Change

Minor copy updates.

How Has This Been Tested?

IntelliJ Idea preview for the text itself.

Checklist (remove irrelevant options):

This is the author self-check list

  • [+] New documentation is provided or existed one is altered.

@olganaumenko olganaumenko added the ctg-documentation Improvements or additions to documentation label Aug 19, 2022
@@ -0,0 +1,11 @@
# System requirements
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think, we should describe system requirements for developers and for contributors separately.

Requirements for developers should include supported Idea versions and a link to the IntelliJ page:
https://www.jetbrains.com/help/idea/supported-java-versions.html#2022

Additionally, we should describe how JAVA_HOME and KOTLIN_HOME may affect tests run.

@olganaumenko olganaumenko merged commit b0652f8 into main Sep 5, 2022
@olganaumenko olganaumenko deleted the olganaumenko/readme_minor_updates branch September 5, 2022 15:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ctg-documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants