fsprojects / fsprojects/FSharpLint

Cross reference docs to F# design guidelines

Open
#162 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement up-for-grabs
Dominant language
F#
Stars
327
Forks
74
PR merge metrics
No merged PRs in 30d

Description

Styling related rules need to be cross referenced in the docs to the F# org's guidelines, and if they can't then the rule should be disabled by default

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the styling-related rules and their documentation, then compare them with the F# organization's component design guidelines at the linked URL. Done means applicable rules cross-reference the guidelines, while rules that cannot be aligned are disabled by default.

Written by the indexing model from the issue text.

Assessment

Tech stack
fsharp
Domain
documentation, tooling
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.