Skip to content

Review UnitTestBot Go README and Developer guide for linguistic and formatting bugs#1814

Merged
olganaumenko merged 3 commits intomainfrom
olganaumenko/go_docs_review
Feb 21, 2023
Merged

Review UnitTestBot Go README and Developer guide for linguistic and formatting bugs#1814
olganaumenko merged 3 commits intomainfrom
olganaumenko/go_docs_review

Conversation

@olganaumenko
Copy link
Copy Markdown
Collaborator

Description

Linguistic bugs fixed, document structure optimized.

How to test

The PR introduces no code changes.
Manual scenario: the text itself has been previewed in the IntelliJ IDEA viewer.

Self-check list

Check off the item if the statement is true. Hint: [x] is a marked item.

Please do not delete the list or its items.

  • I've set the proper labels for my PR (at least, for category and component).
  • PR title and description are clear and intelligible.
  • I've added enough comments to my code, particularly in hard-to-understand areas.
  • The functionality I've repaired, changed or added is covered with automated tests.
  • Manual tests have been provided optionally.
  • The documentation for the functionality I've been working on is up-to-date.

@olganaumenko olganaumenko added ctg-documentation Improvements or additions to documentation comp-fuzzing Issue is related to the fuzzing lang-go Issue is related to Go support labels Feb 17, 2023
#### Installation

<ins>_To install the UTBot Go plugin in IntelliJ IDEA:_</ins>
To install the UnitTestBot Go plugin in IntelliJ IDEA, refer to [UnitTestBot user guide](https://github.com/UnitTestBot/UTBotJava/actions/runs/3012565900).
Copy link
Copy Markdown
Collaborator

@Markoutte Markoutte Feb 17, 2023

Choose a reason for hiding this comment

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

Doesn't the link lead to wrong place?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Thank you! Fixed.

* Go SDK 1.18 or later
* Compatible [Go plugin](https://plugins.jetbrains.com/plugin/9568-go) for IntelliJ IDEA
* Properly configured `go.mod` file for the code under test
* `github.com/stretchr/testify/assert` and `golang.org/x/tools@v0.4.0` Go modules installed (IntelliJ IDEA automatically offers to install them as soon as the tests are generated)
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

It's my mistake. golang.org/x/tools@v0.4.0 will be install automatically during source code analysis.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Thank you! Fixed.

@olganaumenko olganaumenko merged commit 5561be1 into main Feb 21, 2023
@olganaumenko olganaumenko deleted the olganaumenko/go_docs_review branch February 21, 2023 08:49
sofurihafe pushed a commit that referenced this pull request Feb 27, 2023
…ormatting bugs (#1814)

* UnitTestBot Go README and Developer guide reviewed

* Link to user guide fixed

* Requirements fixed
@alisevych alisevych added this to the 2023.03 Release milestone Mar 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

comp-fuzzing Issue is related to the fuzzing ctg-documentation Improvements or additions to documentation lang-go Issue is related to Go support

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants