Feature request: Add a rationale to the rule description
Nobody has claimed this yet.
- Dominant language
- Swift
- Stars
- 19.7k
- Forks
- 2.3k
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 11
Description
New Issue Checklist
- Updated SwiftLint to the latest version
- I searched for existing GitHub issues
Describe the bug
The rule descriptions are quite sparse, and especially for novices, it may be very unclear what the motivation behind a given rule is, and why it might, or might not be, a good idea to enable or disable it.
The idea would be to add a text block to the rule descriptions that could be displayed in the documentation, explaining the rationale behind the rule, possibly with links etc.
Faux Pas (http://fauxpasapp.com) has a feature like this:
Even better would be if there was some way to jump directly to this from the warnings displayed in Xcode.
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
Start by tracing how SwiftLint rule descriptions are defined and rendered in the documentation. Compare the existing descriptions with the proposed rationale text and determine how links and an Xcode warning entry point would fit. Done means the scope is agreed and rationale content can be displayed consistently without leaving the requested behavior unresolved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- swift
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100