Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add style guide #15

Open
jmanuel1 opened this issue Dec 31, 2018 · 0 comments
Open

Add style guide #15

jmanuel1 opened this issue Dec 31, 2018 · 0 comments
Labels
enhancement New feature or request

Comments

@jmanuel1
Copy link
Owner

jmanuel1 commented Dec 31, 2018

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.

@jmanuel1 jmanuel1 added the enhancement New feature or request label Jan 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant