diff --git a/docs/product/issues/suspect-commits/index.mdx b/docs/product/issues/suspect-commits/index.mdx index dbd0fb746ab5aa..908eac8e1e0d4e 100644 --- a/docs/product/issues/suspect-commits/index.mdx +++ b/docs/product/issues/suspect-commits/index.mdx @@ -1,12 +1,12 @@ --- title: Suspect Commits sidebar_order: 32 -description: "Learn how to enable suspect commits, which will help you find the root cause of issues faster." +description: "With suspect commits, you can see the most recent commit to your code in the stack tract. Learn more about how integrations enable suspect commits here." --- -Suspect commits show you the most recent commit to the code in your stack trace. In the suspect commit information, we include the author of the commit and the pull request in which the commit was made. +Suspect commits show you the most recent commit to the code in your [stack trace](https://sentry.io/features/stacktrace/). In the suspect commit information, we include the author of the commit and the pull request in which the commit was made. When you've enabled suspect commits, we can tie together issues with the commits made in your code repository, including the following information: @@ -20,7 +20,7 @@ Suspect commits and suggested assignees are then displayed on the **Issue Detail ## Enable Suspect Commits -In order to see suspect commits, you have to first upload source maps, (or your platform-specific files for mapping transformed source code to the original source). Check out the docs for your [specific platform](/platforms/)) to learn more. Be aware that Sentry will not display suspect commits for issues that were created prior to your integration being set up. +In order to see suspect commits, you have to first upload source maps, (or your platform-specific files for mapping transformed source code to the original source). Check out the docs for your [specific platform](/platforms/)) to learn more. Be aware that Sentry will not display suspect commits for issues that were created before your integration was set up. ### Connect a Repository Using Integrations @@ -61,11 +61,11 @@ Sentry will automatically try to set up code mappings on C#, Go, JavaScript, Nod -The following information is only valid for platforms which use traditional file paths. Platforms with package names require additional steps. For **Java**, read more in the [page on source context](/platforms/java/source-context#setting-up-code-mappings). +The following information is only valid for platforms that use traditional file paths. Platforms with package names require additional steps. For **Java**, read more on the [page on source context](/platforms/java/source-context#setting-up-code-mappings). -First, navigate to a stack trace that you wish to map. Find an **In App** frame, which is denoted by a bubble on the right side of the frame. The filename will be shown as the first piece of text at the left hand side of the frame header. In this example, it is `src/main.py`. +First, navigate to a stack trace that you wish to map. Find an **In App** frame, which is denoted by a bubble on the right side of the frame. The filename will be shown as the first piece of text at the left-hand side of the frame header. In this example, it is `src/main.py`. @@ -97,7 +97,7 @@ Follow along with the interactive demo below to see how to integrate your GitHub ## How It Works -When you have a GitHub/GitLab integration and valid code mappings, Sentry will look at the stack trace of an issue and collect all in-app frames. For each in-app frame, Sentry checks the blame info for the exact file and line number. If the most recent commit is less than 1 year old, we consider it a suspect commit. +When you have a GitHub/GitLab integration and valid [code mappings](https://blog.sentry.io/code-mappings-and-why-they-matter/), Sentry will look at the stack trace of an issue and collect all in-app frames. For each in-app frame, Sentry checks the blame info for the exact file and line number. If the most recent commit is less than 1 year old, we consider it a suspect commit. ## Suspect Commits Without Integrations @@ -117,7 +117,7 @@ There are a few reasons why an issue might not have suspect commits: - The stack trace doesn't have any in-app frames that match the code mappings. - The stack trace doesn't have any in-app frames with recent commits (less than 1 year old). - The code mappings for the project are incorrect. -- The issue was created prior to the integration being set up. +- The issue was created before the integration was set up. ## Where It's Applied