jackfirth / jackfirth/resyntax
Lint Issue Reporting
Nobody has claimed this yet.
- Dominant language
- Racket
- Stars
- 70
- Forks
- 11
- PR merge metrics
- No merged PRs in 30d
Description
Rust has a linting tool known as Clippy that uses an interesting strategy for keeping track of and developing new lints.
Clippy has several categories of lints, that can be enabled individually including one called "nursery". The "nursery" category is for many kinds of experimental lints that probably have mistakes in them, users can opt into this category to get potentially helpful lints at the possibility that they may be wrong or annoying. Clippy also encourages users that encounter bugs in the experimental lints to submit bug reports on their issues page, and as a result, most of the issues are about lints themselves.
Clippy's issue system has labels to keep track of the different kinds of issues with lints including "false positive" (the lint shows up when it shouldn't), "false negative" (the lint doesn't show up when it should), and "suggestion causes error" (where the suggested change is incorrect).
They also have a series of issue templates to make reporting these bugs even easier to users. Resyntax could also include a link to the "false positive" template issue creation page that the user may click on if they believe the suggestion is incorrect (as discussed on discord). Making bug reporting about suggestions very easy to users will get you much more helpful information without the need for anonymous information sharing like was suggested.
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 locating the part of Resyntax that reports bugs or suggestions to users, then review how Clippy links users to false-positive issue templates. Done means users can reach an appropriate false-positive reporting page when a suggestion is incorrect.
Written by the indexing model from the issue text.
Assessment
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100