Skip to content

Commit

Permalink
Update analyzers/src/SonarAnalyzer.ShimLayer/README.md
Browse files Browse the repository at this point in the history
Co-authored-by: Cristian <[email protected]>
  • Loading branch information
1 parent fe8c1f4 commit e41659f
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions analyzers/src/SonarAnalyzer.ShimLayer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,4 @@ They are used to generate the `Lightup` layer. We copy them from Roslyn and not
- Keep our changes and all logic in a dedicated directory `Sonar`, using partial classes, extension methods, and external handlers.
- Keep the namespace. Have different license headers.
- Inject ourselves to the StyleCop code with minimal changes that are annotated with `// Sonar` comment everywhere.
- When importing `Syntax.xml` and `OperationInterfaces.xml`, keep the original file content, including the whitespaces, by downloading the file to the project directory.
If you copy-paste the content, you may lose the whitespaces, and the diff will be harder to read and future updates harder to apply.
- When importing `Syntax.xml` and `OperationInterfaces.xml`, it's important to maintain the original file content, including the whitespaces. To ensure this, download the file directly into the project directory. If you opt to copy and paste the content, you risk losing the whitespaces, which can make the diff more challenging to read and future updates more difficult to implement.

0 comments on commit e41659f

Please sign in to comment.