`Microsoft.Extensions.StaticAnalysis` should be mentioned/encouraged in this documentation
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 82/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Domain
- documentation
Research direction
Open docs/fundamentals/code-analysis/overview.md and read the Code style analysis section referenced by the issue. Add Microsoft.Extensions.StaticAnalysis as the recommended best-practice option before the external analyzers, then verify the rendered wording and links are accurate.
Written by the indexing model from the issue text.
Description
Type of issue
Missing information
Description
In the later sections of the page, many external analyzers are mentioned, but Microsoft.Extensions.StaticAnalysis is completely absent. I assume that this is because that project/package is somewhat new, and the docs here were never updated to mention it.
Instead of initially pushing people towards random third-party packages, the docs should first propose using Microsoft.Extensions.StaticAnalysis as a best practice.
Page URL
Content source URL
https://github.com/dotnet/docs/blob/main/docs/fundamentals/code-analysis/overview.md
Document Version Independent Id
128f9903-971d-6a66-a2cb-9b12acbc55e7
Platform Id
6c404312-136c-21aa-d92a-1cb8ea7ecdcf
Article author
@gewarren
Metadata
- ID: f8906b2c-b984-0427-d064-829e7ea2fc55
- PlatformId: 6c404312-136c-21aa-d92a-1cb8ea7ecdcf
- Service: dotnet-fundamentals
- Dominant language
- No language data
- Stars
- 4.8k
- Forks
- 6.1k
- Avg merge
- 15h 30m
- Merged PRs (30d)
- 374
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from dotnet/docs
-
:watch: Not Triaged dotnet-framework/svc install-deployment/subsvc
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
:watch: Not Triaged
Difficulty 1/5 1-3 hours Newbie friendliness 84/100
-
dotnet-fundamentals/svc waiting-on-feedback
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
dotnet-csharp/svc lang-reference/subsvc
Difficulty 1/5 1-3 hours Newbie friendliness 70/100
-
:watch: Not Triaged
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
agilepathway/label-checker#640 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
BasedHardware/omi#15662 · 1 comment ·
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
documentation good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
amponce/archive-movie-browser#167 ·
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·