Skip to content

Commit bdabafe

Browse files
thomashoneymanthomashoneyman
authored
Update according to Contributors library guidelines (#15)
1 parent ec7284a commit bdabafe

21 files changed

+794
-3999
lines changed

‎.editorconfig

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# http://editorconfig.org
2+
root = true
3+
4+
[*]
5+
indent_style = space
6+
indent_size = 2
7+
end_of_line = lf
8+
charset = utf-8
9+
trim_trailing_whitespace = true
10+
insert_final_newline = true
11+
12+
[*.md]
13+
trim_trailing_whitespace = false

‎.eslintrc.json

Lines changed: 24 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,29 @@
11
{
2-
"parserOptions": {
3-
"ecmaVersion": 5
4-
},
2+
"env": { "browser": true, "commonjs": true },
53
"extends": "eslint:recommended",
6-
"env": {
7-
"commonjs": true
8-
},
4+
"parserOptions": { "ecmaVersion": 5 },
95
"rules": {
10-
"strict": [2, "global"],
11-
"block-scoped-var": 2,
12-
"consistent-return": 2,
13-
"eqeqeq": [2, "smart"],
14-
"guard-for-in": 2,
15-
"no-caller": 2,
16-
"no-extend-native": 2,
17-
"no-loop-func": 2,
18-
"no-new": 2,
19-
"no-param-reassign": 2,
20-
"no-return-assign": 2,
21-
"no-unused-expressions": 2,
22-
"no-use-before-define": 2,
23-
"radix": [2, "always"],
24-
"indent": [2, 2, { "SwitchCase": 1 }],
25-
"quotes": [2, "double"],
26-
"semi": [2, "always"]
27-
},
28-
"globals": {
29-
"setTimeout": true,
30-
"clearTimeout": true,
31-
"setInterval": true,
32-
"clearInterval": true
6+
"block-scoped-var": "error",
7+
"consistent-return": "error",
8+
"eqeqeq": "error",
9+
"guard-for-in": "error",
10+
"no-bitwise": "error",
11+
"no-caller": "error",
12+
"no-extra-parens": "off",
13+
"no-extend-native": "error",
14+
"no-loop-func": "error",
15+
"no-new": "error",
16+
"no-param-reassign": "error",
17+
"no-return-assign": "error",
18+
"no-sequences": "error",
19+
"no-unused-expressions": "error",
20+
"no-use-before-define": "error",
21+
"no-undef": "error",
22+
"no-eq-null": "error",
23+
"radix": ["error", "always"],
24+
"indent": ["error", 2, { "SwitchCase": 1 }],
25+
"quotes": ["error", "double"],
26+
"semi": ["error", "always"],
27+
"strict": ["error", "global"]
3328
}
3429
}

‎.github/CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Contributing to JS Timers
2+
3+
Thanks for your interest in contributing to `js-timers`! We welcome new contributions regardless of your level of experience or familiarity with PureScript.
4+
5+
Every library in the Contributors organization shares a simple handbook that helps new contributors get started. With that in mind, please [read the short contributing guide on purescript-contrib/governance](https://github.com/purescript-contrib/governance/blob/main/contributing.md) before contributing to this library.

‎.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Bug report
3+
about: Report an issue
4+
title: ""
5+
labels: bug
6+
assignees: ""
7+
---
8+
9+
**Describe the bug**
10+
A clear and concise description of the bug.
11+
12+
**To Reproduce**
13+
A minimal code example (preferably a runnable example on [Try PureScript](https://try.purescript.org)!) or steps to reproduce the issue.
14+
15+
**Expected behavior**
16+
A clear and concise description of what you expected to happen.
17+
18+
**Additional context**
19+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/change-request.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: Change request
3+
about: Propose an improvement to this library
4+
title: ""
5+
labels: ""
6+
assignees: ""
7+
---
8+
9+
**Is your change request related to a problem? Please describe.**
10+
A clear and concise description of the problem.
11+
12+
Examples:
13+
14+
- It's frustrating to have to [...]
15+
- I was looking for a function to [...]
16+
17+
**Describe the solution you'd like**
18+
A clear and concise description of what a good solution to you looks like, including any solutions you've already considered.
19+
20+
**Additional context**
21+
Add any other context about the change request here.

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
**Description of the change**
2+
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.
3+
4+
---
5+
6+
**Checklist:**
7+
8+
- [ ] Added the change to the changelog's "Unreleased" section with a link to this PR and your username
9+
- [ ] Linked any existing issues or proposals that this pull request should close
10+
- [ ] Updated or added relevant documentation in the README and/or documentation directory
11+
- [ ] Added a test for the contribution (if applicable)

‎.github/contributing.md

Lines changed: 0 additions & 51 deletions
This file was deleted.

‎.github/issue_template.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

‎.github/pull_request_template.md

Lines changed: 0 additions & 15 deletions
This file was deleted.

‎.github/workflows/ci.yml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- uses: actions/checkout@v2
15+
16+
- name: Set up PureScript toolchain
17+
uses: purescript-contrib/setup-purescript@main
18+
19+
- name: Cache PureScript dependencies
20+
uses: actions/cache@v2
21+
with:
22+
key: ${{ runner.os }}-spago-${{ hashFiles('**/*.dhall') }}
23+
path: |
24+
.spago
25+
output
26+
27+
- name: Set up Node toolchain
28+
uses: actions/setup-node@v1
29+
with:
30+
node-version: "12.x"
31+
32+
- name: Cache NPM dependencies
33+
uses: actions/cache@v2
34+
env:
35+
cache-name: cache-node-modules
36+
with:
37+
path: ~/.npm
38+
key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
39+
restore-keys: |
40+
${{ runner.os }}-build-${{ env.cache-name }}-
41+
${{ runner.os }}-build-
42+
${{ runner.os }}-
43+
44+
- name: Install NPM dependencies
45+
run: npm ci
46+
47+
- name: Build the project
48+
run: npm run build
49+
50+
- name: Run tests
51+
run: npm run test

‎.github/workflows/stale.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: "Stale"
2+
3+
on:
4+
schedule:
5+
- cron: "0 0 * * *"
6+
7+
jobs:
8+
stale:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/stale@v3
12+
env:
13+
days-until-stale: 60
14+
days-until-close: 14
15+
with:
16+
repo-token: ${{ secrets.GITHUB_TOKEN }}
17+
stale-issue-message: "This issue is stale because it has been open for ${{ env.days-until-stale }} days with no activity. Remove the stale label or comment to keep this issue open. Otherwise, this issue will be closed in ${{ env.days-until-close }} days."
18+
stale-pr-message: "This pull request is stale because it has been open for ${{ env.days-until-stale }} days with no activity. Remove the stale label or comment to keep this pull request open. Otherwise, this pull request will be closed in ${{ env.days-until-close }} days."
19+
days-before-stale: ${{ env.days-until-stale }}
20+
days-before-close: ${{ env.days-until-close }}
21+
stale-issue-label: "stale"
22+
stale-pr-label: "stale"
23+
exempt-pr-labels: "breaking change"

‎.gitignore

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
1-
/.*
2-
!/.gitignore
3-
!/.github
4-
!/.eslintrc.json
5-
!/.travis.yml
6-
/bower_components/
7-
/node_modules/
8-
/output/
1+
.*
2+
!.gitignore
3+
!.github
4+
!.editorconfig
5+
!.eslintrc.json
6+
7+
output
8+
generated-docs
9+
10+
node_modules
11+
*.lock

‎.travis.yml

Lines changed: 0 additions & 24 deletions
This file was deleted.

0 commit comments

Comments
 (0)