Skip to content

Commit

Permalink
Clarifying placing rules
Browse files Browse the repository at this point in the history
  • Loading branch information
Piedone committed Oct 16, 2023
1 parent 56e1067 commit 9f7729b
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,4 +75,5 @@ When adding a new analyzer package, do the following:
- Go through all rules in the package and decide one by one whether we need them.
- Check for rules that are already covered by some other analyzer and disable duplicates.
- All rules that we need should be surfaced as Warnings. This allows to only break the build on analyzer violations when we need it, i.e. during CI builds but not during development.
- Add rule configuration to the _.globalconfig_ file of the relevant project, depending on which kind of applications they're applicable to. Editor-only configuration should be in _.editorconfig_ files.
- Test it on multiple significant solutions. Using the [Hastlayer SDK](https://github.com/Lombiq/Hastlayer-SDK) is a good example as it's a large C# solution.

0 comments on commit 9f7729b

Please sign in to comment.