Generate Tests Using GitHub Issues

After installing GitAuto, you can create tests directly from GitHub issues with a few simple steps.

Create a new GitHub issue

Screenshot showing the GitHub 'New Issue' page. The image displays the issue creation form with fields for title and description. Take a screenshot of your repository's issue creation page with a sample title like 'Generate tests for user authentication'.

Create a new issue in your GitHub repository. The title can be anything descriptive about what you want to test.

Check the GitAuto checkbox

Screenshot showing a GitHub issue with GitAuto's automated comment containing a checkbox. The image shows an issue thread where GitAuto has added a comment that contains a checkbox labeled 'Generate tests with GitAuto'. The screenshot should show the checkbox both unchecked and then checked.

GitAuto will automatically add a comment to your issue with a checkbox. Check this box to trigger GitAuto to analyze your issue and generate test cases and a pull request.

Note: For existing issues without the GitAuto checkbox, you can add the "gitauto" label to trigger the same functionality. No worries, I'll get into the details next.

Review and merge the pull request

Screenshot showing the pull request created by GitAuto. The image displays a GitHub pull request page with code changes for the generated tests. Take a screenshot of a sample PR that shows test files being added with visible code changes.

GitAuto will create a pull request with the generated tests. Review the code, make any necessary adjustments, and merge the pull request to add the tests to your repository.