How to Use Ellipsis

Getting started with Ellipsis

In this guide, you will learn how to set up Ellipsis, integrate it with your GitHub account, and start using it to review your code and fix bugs in pull requests (PRs). After following these steps, you’ll be ready to streamline your code review process.

Step 1: Sign up and set up

1. Go to the Ellipsis website.
2. Click on the “Get Started” button located prominently on the homepage.
3. Sign up using your GitHub account by selecting “Sign in with GitHub.” Authorise Ellipsis to access your repositories.
4. Follow the prompts to complete the onboarding process, where you can select your preferred repositories for integration.

Step 2: Your first code review

1. Navigate to your GitHub repository and create a pull request (PR) as you normally would.
2. Once the PR is created, you’ll see an option to “Review with Ellipsis” in the PR interface.
3. Click on this button, and Ellipsis will start analysing your code. Wait for a moment while it reviews the changes.
4. When the review is complete, Ellipsis will provide feedback directly in the PR comments, highlighting issues and suggesting fixes.

Step 3: Get better results

• To improve the quality of reviews, ensure your code follows standard conventions and is well-documented. Ellipsis works best with clean code.
• You can adjust the settings in Ellipsis to focus on specific types of checks. Navigate to “Settings” in the Ellipsis dashboard, and select the types of issues you want it to prioritise (e.g., performance, security).
• Regularly check the “Activity” tab to understand common issues flagged by Ellipsis, which can help you improve your coding practices over time.

Pro tip

Use the “Review History” feature to track changes in your code reviews. This will help you learn from past mistakes and improve your coding style.

Common mistake to avoid

Don’t skip the initial configuration steps after signing up. Failing to properly set up your repository access and preferences can lead to incomplete reviews and missed bugs. Always ensure you have granted the necessary permissions for Ellipsis to function effectively.