-
Notifications
You must be signed in to change notification settings - Fork 79
Update for Contributors library guidelines #153
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
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# https://editorconfig.org | ||
root = true | ||
|
||
[*] | ||
indent_style = space | ||
indent_size = 2 | ||
end_of_line = lf | ||
charset = utf-8 | ||
trim_trailing_whitespace = true | ||
insert_final_newline = true | ||
|
||
[*.md] | ||
trim_trailing_whitespace = false |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,29 @@ | ||
{ | ||
"parserOptions": { | ||
"ecmaVersion": 5 | ||
}, | ||
"env": { "commonjs": true }, | ||
"extends": "eslint:recommended", | ||
"env": { | ||
"commonjs": true | ||
}, | ||
"parserOptions": { "ecmaVersion": 5 }, | ||
"rules": { | ||
"strict": [2, "global"], | ||
"block-scoped-var": 2, | ||
"consistent-return": 2, | ||
"eqeqeq": [2, "smart"], | ||
"guard-for-in": 2, | ||
"no-caller": 2, | ||
"no-extend-native": 2, | ||
"no-loop-func": 2, | ||
"no-new": 2, | ||
"no-param-reassign": 2, | ||
"no-return-assign": 2, | ||
"no-unused-expressions": 2, | ||
"no-use-before-define": 2, | ||
"radix": [2, "always"], | ||
"indent": [2, 2], | ||
"quotes": [2, "double"], | ||
"semi": [2, "always"] | ||
"block-scoped-var": "error", | ||
"consistent-return": "error", | ||
"eqeqeq": "error", | ||
"guard-for-in": "error", | ||
"no-bitwise": "error", | ||
"no-caller": "error", | ||
"no-extra-parens": "off", | ||
"no-extend-native": "error", | ||
"no-loop-func": "error", | ||
"no-new": "error", | ||
"no-param-reassign": "error", | ||
"no-return-assign": "error", | ||
"no-sequences": "error", | ||
"no-unused-expressions": "error", | ||
"no-use-before-define": "error", | ||
"no-undef": "error", | ||
"no-eq-null": "error", | ||
"radix": ["error", "always"], | ||
"indent": ["error", 2, { "SwitchCase": 1 }], | ||
thomashoneyman marked this conversation as resolved.
Show resolved
Hide resolved
|
||
"quotes": ["error", "double"], | ||
"semi": ["error", "always"], | ||
"strict": ["error", "global"] | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
--- | ||
name: Bug report | ||
about: Report an issue | ||
title: "" | ||
labels: bug | ||
assignees: "" | ||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of the bug. | ||
|
||
**To Reproduce** | ||
A minimal code example (preferably a runnable example on [Try PureScript](https://try.purescript.org)!) or steps to reproduce the issue. | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Additional context** | ||
Add any other context about the problem here. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
name: Change request | ||
about: Propose an improvement to this library | ||
title: "" | ||
labels: "" | ||
assignees: "" | ||
--- | ||
|
||
**Is your change request related to a problem? Please describe.** | ||
A clear and concise description of the problem. | ||
|
||
Examples: | ||
|
||
- It's frustrating to have to [...] | ||
- I was looking for a function to [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what a good solution to you looks like, including any solutions you've already considered. | ||
|
||
**Additional context** | ||
Add any other context about the change request here. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: PureScript Discourse | ||
url: https://discourse.purescript.org/ | ||
about: Ask and answer questions here. | ||
- name: Functional Programming Slack | ||
url: https://functionalprogramming.slack.com | ||
about: For casual chat and questions (use https://fpchat-invite.herokuapp.com to join). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
**Description of the change** | ||
Clearly and concisely describe the purpose of the pull request. If this PR relates to an existing issue or change proposal, please link to it. Include any other background context that would help reviewers understand the motivation for this PR. | ||
|
||
--- | ||
|
||
**Checklist:** | ||
|
||
- [ ] Added the change to the changelog's "Unreleased" section with a link to this PR and your username | ||
- [ ] Linked any existing issues or proposals that this pull request should close | ||
- [ ] Updated or added relevant documentation in the README and/or documentation directory | ||
- [ ] Added a test for the contribution (if applicable) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
name: CI | ||
|
||
on: | ||
push: | ||
branches: [main] | ||
pull_request: | ||
branches: [main] | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v2 | ||
|
||
- name: Set up PureScript toolchain | ||
uses: purescript-contrib/setup-purescript@main | ||
|
||
- name: Cache PureScript dependencies | ||
uses: actions/cache@v2 | ||
with: | ||
key: ${{ runner.os }}-spago-${{ hashFiles('**/*.dhall') }} | ||
path: | | ||
.spago | ||
output | ||
|
||
- name: Set up Node toolchain | ||
uses: actions/setup-node@v1 | ||
with: | ||
node-version: "12.x" | ||
|
||
- name: Cache NPM dependencies | ||
uses: actions/cache@v2 | ||
env: | ||
cache-name: cache-node-modules | ||
with: | ||
path: ~/.npm | ||
key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package.json') }} | ||
restore-keys: | | ||
${{ runner.os }}-build-${{ env.cache-name }}- | ||
${{ runner.os }}-build- | ||
${{ runner.os }}- | ||
|
||
- name: Install NPM dependencies | ||
run: npm install | ||
|
||
- name: Build the project | ||
run: npm run build | ||
|
||
- name: Run tests | ||
run: npm run test |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,13 @@ | ||
/.* | ||
!/.gitignore | ||
!/.github | ||
!/.travis.yml | ||
.* | ||
!.gitignore | ||
!.github | ||
!.editorconfig | ||
!.eslintrc.json | ||
|
||
# Dependencies | ||
bower_components | ||
node_modules | ||
|
||
# Generated files | ||
output | ||
dce-output | ||
generated-docs | ||
bower_components | ||
|
||
# Lockfiles | ||
node_modules | ||
package-lock.json | ||
*.lock | ||
|
||
# Extra files | ||
!/.eslintrc.json |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
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.
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.
The original file has
[2, "smart"]
. Do we need to keep that?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.
It's been overwritten to use the standard, which is a bit stricter, but makes it more explicit when you're choosing to compare against null / undefined.