Skip to content

Add style guide #15

@jmanuel1

Description

@jmanuel1

Include a style guide for F# code. Perhaps, include a style guide for prose too.

An example F# style guide: https://docs.microsoft.com/en-us/dotnet/fsharp/style-guide/

image

An example prose style guide: https://plainlanguage.gov/guidelines/

image

Currently, there is no style guide being followed (except for Visual F#'s suggestions). There should be an F# style guide to follow and prose guidelines to follow. This will help make the code easier to read, better designed, and more maintainable. A prose guide will help improve documentation making it clear and easier to read.

These enhancements would be useful in maintaining the consistency of code and prose.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions