Update the code fix to respect markdown rules

[Youssef1313]

@mavasani FYI, the code that generates this need to be updated to respect markdown rules, i.e. leave blank lines around headings.

See https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md022---headings-should-be-surrounded-by-blank-lines

Originally posted by @Youssef1313 in #4126 (comment)

[Evangelink]

@Youssef1313 Do you want to handle the ticket?

[Youssef1313]

@Evangelink I'm not very familiar with this area and how exactly it works. So I think someone else can get it faster than me. But if it became a stale for a while, I'll probably give it a try.

[Evangelink]

I'll take care of it :)

[Evangelink]

@mavasani Shall I use Environment.NewLine or force the \n line ending? I am a bit concerned that we might have some errors with non-windows environments. I guess I could probably start with the NewLine and wait to see results of the ubuntu pipeline.

[Youssef1313]

@Evangelink The fixer currently appends Environment.NewLine (it uses StringBuilder.AppendLine):

roslyn-analyzers/src/Microsoft.CodeAnalysis.Analyzers/Core/MetaAnalyzers/Fixers/AnalyzerReleaseTrackingFix.cs

Line 438 in b148fa8

builder.AppendLine(ReleaseTrackingHelper.TableTitleNewRules);

I'm a bit surprised that the current Linux builds doesn't fail 😄
The files in repo are using \r\n, and Linux build will produce \n, so the comparison should fail. Why it doesn't? I don't know. 😕 (The analyzer ignores the end of lines - it loops through all lines, not comparing exact text match):

roslyn-analyzers/src/Microsoft.CodeAnalysis.Analyzers/Core/MetaAnalyzers/ReleaseTrackingHelper.cs

Line 49 in 5102a0d

foreach (TextLine line in sourceText.Lines)

[Evangelink]

Thanks @Youssef1313! I wrote my comment before looking at the code and then thought it was a stupid question but felt weird to delete my comment afterward.

[Evangelink]

@Youssef1313 do you recall if there was anything else than the header blank line that wasn't covered?

[Youssef1313]

@Evangelink I don't. But we'll know when markdownlint is enabled.