Add troubleshooting section for flaky tests in GitHub summary (#1647)

Author: lukaszcl

tools/flakeguard/reports/presentation.go

@@ -100,6 +100,10 @@ func GenerateGitHubSummaryMarkdown(w io.Writer, testReport *TestReport, maxPassR
 	if artifactLink != "" {
 		renderArtifactSection(w, artifactName, artifactLink)
 	}
+
+	if testReport.SummaryData.FlakyTests > 0 {
+		renderTroubleshootingSection(w)
+	}
 }
 
 // GeneratePRCommentMarkdown generates a markdown summary of the test results for a GitHub PR comment.
@@ -242,6 +246,14 @@ func renderArtifactSection(w io.Writer, artifactName, artifactLink string) {
 	}
 }
 
+// renderTroubleshootingSection appends a troubleshooting section with a link to the README
+func renderTroubleshootingSection(w io.Writer) {
+	fmt.Fprintln(w)
+	fmt.Fprintln(w, "## Troubleshooting Flaky Tests 🔍")
+	fmt.Fprintln(w)
+	fmt.Fprintln(w, "For guidance on diagnosing and resolving E2E test flakiness, refer to the [Finding the Root Cause of Test Flakes](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/tools/flakeguard/e2e-flaky-test-guide.md) guide.")
+}
+
 // printTable prints a markdown table to the given writer in a pretty format.
 func printTable(w io.Writer, table [][]string, collapsible bool) {
 	colWidths := calculateColumnWidths(table)