feat: Document "Fix issues" button (#2116)

* feat: Document "Fix issues" button * feat: Apply suggestions from review Co-authored-by: Cláudia Carpinteiro <[email protected]> * feat: Apply review feedback and add screenshots --------- Co-authored-by: Cláudia Carpinteiro <[email protected]>
codacy · May 30, 2024 · 3e39dd6 · 3e39dd6
1 parent 22fba06
commit 3e39dd6
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 0 deletions.
diff --git a/docs/repositories/images/issues-fix-issues-button.png b/docs/repositories/images/issues-fix-issues-button.png
diff --git a/docs/repositories/images/repository-dashboard-issues-breakdown.png b/docs/repositories/images/repository-dashboard-issues-breakdown.png
diff --git a/docs/repositories/issues.md b/docs/repositories/issues.md
@@ -94,6 +94,14 @@ To restore an ignored issue, select **Unignore issue** from the options menu:
 
 ![Restoring an ignored issue](images/issues-unignore.png)
 
+## Fixing issues automatically
+
+!!! info "This section applies to GitHub repositories only"
+
+If Codacy detects code patterns that have suggested fixes, a **Fix issues** button appears above the issue list. Click this button to open a pull request including the suggested fixes and targeting the selected branch.
+
+![Fix issues button](images/issues-fix-issues-button.png)
+
 ## See also
 
 -   [Which metrics does Codacy calculate?](../faq/code-analysis/which-metrics-does-codacy-calculate.md)

diff --git a/docs/repositories/pull-requests.md b/docs/repositories/pull-requests.md
@@ -47,6 +47,14 @@ Click a specific commit to see [detailed information about that commit](commits.
 
 ![Commits tab](images/pull-requests-tab-commits.png)
 
+## Fixing issues automatically
+
+!!! info "This section applies to GitHub repositories only"
+
+If Codacy detects code patterns that have suggested fixes, a **Fix issues** button appears above the issue list. Click this button to commit the suggested fixes to the pull request.
+
+![Fix issues button](images/issues-fix-issues-button.png)
+
 ## See also
 
 -   [Which metrics does Codacy calculate?](../faq/code-analysis/which-metrics-does-codacy-calculate.md)
diff --git a/docs/repositories/repository-dashboard.md b/docs/repositories/repository-dashboard.md
@@ -48,6 +48,8 @@ The **Issues breakdown** area displays the total number of issues found on the s
 
 Click **See all issues** to see the full [list of issues](issues.md) found, or click a category to see the issues in that category.
 
+If Codacy detects code patterns that have suggested fixes, a **Fix issues** button appears below the total issue count. Click this button to open a pull request including the suggested fixes and targeting the selected branch.
+
 ![Issues breakdown](images/repository-dashboard-issues-breakdown.png)
 
 ## Coverage