Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
lib: Add contribution guidelines #272083
lib: Add contribution guidelines #272083
Changes from all commits
395fc06
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section feels a bit arbitrary. I agree that naming is important, but I'm having a hard time to figure out if a name is good or bad, only based on this information.
Providing examples of good and bad names accompanied with explanations, or links to similar functional libraries (maybe hoogle or elm?) might be a good addition. Or maybe recommend people to read through earlier PRs tagged with https://github.com/NixOS/nixpkgs/labels/6.topic:%20lib, to see the name discussions there and get a feeling for it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we're going to refer to languages, we'd have to point out the differences as well. That is, link to a document that does that.
Here's a few things:
mapNullable
is not a lawful functor. It behaves like>>=
/flatMap
.Nullable (Nullable a) == Nullable a
, etc. Less suitable for composition.Map.union
is flipped compared to//
.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Until we codify anything: maybe make it "here's what we think" and "if you don't know, just open a PR and let's talk about it"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added
to this item. I don't think we could have very concrete guidelines here for now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not a fan of that section, but sure we have it, let's reference it. Most of it should become obsolete with NixOS/rfcs#166 :)