fsprojects / fsprojects/FSharpLint
feat: "DotnetNamingConventions" rule
Open
Nobody has claimed this yet.
- Dominant language
- F#
- Stars
- 327
- Forks
- 74
- PR merge metrics
- No merged PRs in 30d
Description
- Interfaces names should start with
I. - Generic type names should start with
T. - Exception type names should end with
Exception. - Methods/funcs names starting with
Asyncshould have return typeAsync<_>. - Methods/funcs names finishing with
Asyncshould have return typeTaskorTask<_>. - Last but not least, a cosmetic one: any name containing the string
Fsharpshould be flagged and recommend proper capitalisationFSharp.
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
The issue body defines the DotnetNamingConventions rule and its five naming or return-type checks. Start by locating the existing rule entry points and related tests in FSharpLint, then determine how each convention is represented and reported. Done means all listed conventions are checked, including the Fsharp-to-FSharp recommendation, with tests covering the behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- fsharp
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100