[Feature] Add links to rules documentation
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 460
- Forks
- 29
- Avg merge
- 4d 9h
- Merged PRs (30d)
- 7
Description
**Is your feature request related to a problem? Please describe.**
I see rule violations but do not understand the reason for the rule/violation
**Describe the solution you'd like**
Build output should contain a link to a web page documenting the rule
**Additional context**
Sample output from the rules I publish (makes a nice clickable link in the VS build output pane)
`1>C:\Code\Github\SqlServer.Rules\TSQLSmellsTest\SETs.sql(10,1): warning SML013: Smells : CONCAT_NULL_YIELDS_NULL should be on. (https://github.com/ErikEJ/SqlServer.Rules/blob/master/docs/CodeSmells/SML013.md)
`
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.
Research direction
No file, test, or entry point is named. Start by locating the code that formats rule violations in build output and the rule metadata it receives; done means emitted warnings include clickable links to pages documenting the reported rule.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, sql
- Domain
- build-system, developer-experience, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100