How to Use Entelligence

Getting started with Entelligence

After reading this guide, you will be able to sign up for Entelligence, run your first code review, and optimise your results to catch more bugs effectively.

Step 1: Sign up and set up

1. Go to Entelligence's website.
2. Click on the "Sign Up" button in the top right corner.
3. Enter your email address and create a password. Alternatively, you can sign up using a GitHub account by clicking the "Sign up with GitHub" button.
4. Confirm your email via the link sent to your inbox.
5. Once signed in, you’ll be prompted to connect your code repository. Follow the on-screen instructions to link your GitHub or Bitbucket account.

Step 2: Your first code review

1. After connecting your repository, navigate to the "Projects" tab on the left sidebar.
2. Click the "New Project" button.
3. Select the repository you want to analyse from the dropdown menu.
4. Click "Create Project." The tool will start scanning your code.
5. Once the scan is complete, go to the "Reports" section to view the results. Here, you'll see issues detected, including bugs and suggestions for improvements.

Step 3: Get better results

1. To enhance the accuracy of your reviews, ensure your code is well-organised and uses consistent naming conventions.
2. Use the "Settings" option in your project to adjust the sensitivity of the analysis. A higher sensitivity can catch more issues but may also generate false positives.
3. Regularly update your project settings and run reviews after significant changes to your codebase to keep results relevant.

Pro tip

Use the "Integrations" menu to connect Entelligence with your CI/CD pipeline. This way, you can automate code reviews as part of your development workflow, saving time on manual checks.

Common mistake to avoid

A common mistake is neglecting to regularly update your project settings after adding new dependencies or making significant code changes. This can lead to outdated reviews that miss new bugs. Always run a fresh analysis after major updates.