-
Notifications
You must be signed in to change notification settings - Fork 65
Update for Contributors library guidelines #176
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
Conversation
main :: Effect Unit | ||
main = do | ||
log "🍝" | ||
log "You should add some tests." |
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'm aware this test does nothing at the moment, but we may (in the future) want to write something small here which minimally exercises the bindings as a sanity check when making future changes. Having this directory ready to go and running in CI makes it easier for contributors to help add tests in the future.
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 think this is the right call. Having the test structure in place will definitely make for a smoother experience if someone wants to add some tests.
@thomashoneyman I'm wondering if we should suppress the eslint warnings for the purposes of this PR and then come back and remove the suppressions and fix the offending code in a separate PR? |
That's a better idea. Thanks for the suggestion. |
This reverts commit 4161926.
"react": "^16.3.0" | ||
"private": true, | ||
"scripts": { | ||
"build": "spago build --purs-args '--censor-lib --strict'", |
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.
In a subsequent PR we can enable eslint via eslint src && spago build ...
here.
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.
LGTM 👍
This pull request is part of an effort to update and standardize the Contributors libraries according to the Library Guidelines. Specifically, it:
test
directory.In this library's case, I've taken a few specific actions.
docs
directory and linked to it from the README, for parity with how all the other contrib-libraries are handling this.This PR isn't intended to change the code whatsoever, just to make sure that this library is using the same configurations and processes as the other libraries in this organization. With that in mind, despite adding the eslint configuration, this configuration is currently disabled so that it can be evaluated separately in a followup PR.