Fix issues

When addressing code health issues flagged in the DeepSource dashboard, you have two options. The first approach involves manually fixing the issues, while the second method involves Autofix™ — our auto remediation engine.

Manual fix

If you choose to manually fix the issues, you can follow these steps:

  1. Open any issue from the Issues tab and examine the occurrences of the issue. You can identify where the issue exists in the codebase and read the issue description to gain a full understanding of what needs to be fixed and the code changes that are required to address the problem.

  1. Referring to the contextual code can provide you with a better understanding of the issue.
    Manually make the necessary edits in your code and push a commit.
  2. DeepSource will automatically analyze every pull-request and new commits on all new and existing pull-requests.
  3. Once the checks finish, you will see checks that have passed and some that have failed. If a check passes, it means that the DeepSource Analyzer did not find any issues in the changes made in the PR. If a check fails, it means that there are issues that need to be addressed.
  4. You can click on the ‘details’ view to gain more context on the failing checks and learn how to address the issue effectively.


Installing the Autofix™ app

In the dashboard, you'll see a prompt to install the Autofix™ app. Simply click 'Install Autofix' to begin. If you're using an organization or team account, you can choose to install Autofix on all repositories or select repositories. After you click 'Install', you'll be taken to the VCS provider's App site to finish the setup.

Using Autofix™: The dashboard workflow

If you open an issue from the dashboard that has Autofix™ support, you’ll see the Autofix™ button on the top. All you have to do is click on it and confirm which files you want to run Autofix™ on.

It takes a few seconds for DeepSource to generate the fixes, and once you’ve verified all the fixes, click on the ‘Create pull request’ button, and DeepSource will create a pull request with fixes for this issue on your repository automatically.

Using Autofix™: The pull-request workflow

Once you’ve made a new pull request on your GitHub repository, DeepSource analysis will start right away. Once the checks finish, click on the ‘details’ action adjacent to a failing check to view the issues you’ve just introduced.

If any of these issues support Autofix™, you’ll see the Autofix™ button. In this case, the only difference is that running Autofix™ will create a commit directly on the PR.