fsprojects / fsprojects/FSharpLint
SuggestedFix structure
Nobody has claimed this yet.
- Dominant language
- F#
- Stars
- 327
- Forks
- 74
- PR merge metrics
- No merged PRs in 30d
Description
Description
I wanted to add a quick fix suggestion for linter warnings like RecordFieldNames (to add to the beginning of the file a //fsharplint:disable RecordFieldNames).
I was looking at the FSharpLint.Framework.Suggestion.SuggestedFix record and didn't understood how I suppose to do that(what I described above), maybe are some conventions in place, but are undocumented.
Can somebody guide me through the process? I need some tips.
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 with the FSharpLint.Framework.Suggestion.SuggestedFix record mentioned in the issue and inspect existing conventions for linter warning fixes. Clarify and document how a fix should add a file-level //fsharplint:disable RecordFieldNames directive, including an example of the expected result.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- fsharp
- Domain
- tooling
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100