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 first cut of style guide #263

Merged
merged 7 commits into from May 21, 2019

Conversation

mankyKitty
Copy link
Contributor

I mined a recent PR for most of these so fair to say there is plenty of adjustment required.

But it is easier to have this discussion here.

STYLE_GUIDE.md Outdated Show resolved Hide resolved
Copy link
Member

@moodmosaic moodmosaic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks nice and clean to me so far 🌞 🌞

Copy link
Member

@jacobstanley jacobstanley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks pretty good, just a few small comments, I actually made them a while ago but they weren't display because I hadn't submitted the review, sorry about that.

STYLE_GUIDE.md Outdated Show resolved Hide resolved
STYLE_GUIDE.md Show resolved Hide resolved
STYLE_GUIDE.md Outdated Show resolved Hide resolved
STYLE_GUIDE.md Outdated Show resolved Hide resolved
STYLE_GUIDE.md Outdated Show resolved Hide resolved
@moodmosaic
Copy link
Member

Perhaps we should add some module ( ..., import ..., and import qualified ... examples too.

@mankyKitty
Copy link
Contributor Author

I'm back from holidays so I'll be able to get back on this. :)

Foo xs ->
unlines xs
Bar xs ->
unlines xs
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LambdaCase has to be one of my favorite extensions, so much less noise here.

@jacobstanley jacobstanley self-requested a review May 5, 2019 02:10
@jacobstanley jacobstanley self-requested a review May 5, 2019 02:11
Copy link
Member

@jacobstanley jacobstanley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, just the one comment about qualified imports

STYLE_GUIDE.md Show resolved Hide resolved
…erything that isn't the top level to be a second level heading.
* Added note about line length
* Added section on module imports/declarations
* Updated section regarding use of typeclass constraints
* Added note about use of LambdaCase extension
* Added section about requiring documentation for all public facing
  functions.
@jacobstanley jacobstanley merged commit 74dc7e0 into hedgehogqa:master May 21, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants