Skip to content

Unit test gen docs #398

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jun 13, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
let them ask the question
  • Loading branch information
Howon Lee committed Jun 12, 2025
commit 0bbfe70db728f3921db940897fea94693bdb3239
4 changes: 2 additions & 2 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,15 @@ We're excited to announce that two new static analysis tools are now supported o

### Unit Test Generation, Early Access

We're excited to announce our new unit test generation feature, for early access! CodeRabbit can now automatically generate unit tests for your code changes.
We're excited to announce that our new unit test generation feature is now available in early access! CodeRabbit can now automatically generate unit tests for your code changes.

Key capabilities:

- **Intelligent Test Generation**: Automatically creates unit tests that cover edge cases, error scenarios, and core functionality
- **Context-Aware**: Generates tests that understand your existing codebase patterns and testing conventions
- **One-Click Integration**: Simply comment `@coderabbitai auto-generate unit tests` on any pull request or specific file, or click on the checkbox available in the walkthrough comment for Early Access customers.

The generated tests can be easily customized to fit your specific requirements.
You can customize the generated tests to fit your specific requirements.

## June 5, 2025

Expand Down
2 changes: 1 addition & 1 deletion docs/finishing-touches/docstrings.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Docstrings generation is part of the [finishing touches](/future-development#fin

## Usage

Once you are done with your pull request and its reviews, you may want to perform finishing touches to your code, such as adding in-code documentation. You can request CodeRabbit to generate docstrings by typing `@coderabbitai generate docstrings` in a comment under that pull request or by clicking the `📝 Generate Docstrings` checkbox under `✨ Finishing Touches` in the CodeRabbit Walkthrough.
Once you are done with your pull request and its reviews, you may want to perform finishing touches to your code, such as adding in-code documentation. You can request CodeRabbit to generate docstrings by typing `@coderabbitai generate docstrings` in a comment under that pull request or by clicking the **Generate Docstrings** checkbox under **Finishing Touches** in the CodeRabbit Walkthrough.

Once sent, CodeRabbit will perform the following actions:

Expand Down
10 changes: 1 addition & 9 deletions docs/finishing-touches/unit-test-generation.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Unit Test Generation is an Early Access Experimental feature.

## Usage

Once you are done with your pull request and its reviews, you may want to perform finishing touches to your code, such as adding unit tests. You can request CodeRabbit to generate unit tests by typing `@coderabbitai auto-generate unit tests` in a comment under that pull request or by clicking a checkbox under `🧪 Generate Unit Tests` in the CodeRabbit Walkthrough.
Once you are done with your pull request and its reviews, you may want to perform finishing touches to your code, such as adding unit tests. You can request CodeRabbit to generate unit tests by typing `@coderabbitai auto-generate unit tests` in a comment under that pull request or by clicking a checkbox under **Generate Unit Tests** in the CodeRabbit Walkthrough.

Once sent, CodeRabbit will perform the following actions:

Expand Down Expand Up @@ -50,16 +50,8 @@ These software forges are supported:

- GitHub

We are working on GitLab and Azure DevOps support as of writing.

## Supported CI/CD systems

These CI/CD systems are supported for post-generation adjustments:

- GitHub actions

We are working on CircleCI and Travis CI support as of writing.

## Supported languages

Any programming language and unit test library / framework known to the LLM is supported.