Skip to content

Commit cb9dfbb

Browse files
committed
Docs(github): update github related docs
1 parent 87fc936 commit cb9dfbb

File tree

7 files changed

+80
-85
lines changed

7 files changed

+80
-85
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,19 @@ PLEASE HELP US PROCESS GITHUB ISSUES FASTER BY PROVIDING THE FOLLOWING INFORMATI
44
ISSUES MISSING IMPORTANT INFORMATION MAY BE CLOSED WITHOUT INVESTIGATION.
55
-->
66

7-
# I'm submitting a
7+
<!-- Please search GitHub for a similar issue or PR before submitting -->
88

9-
<!-- Check one of the following options with "x" -->
9+
# I'm submitting a
1010

11-
- [ ] Bug report <!-- Please search GitHub for a similar issue or PR before submitting -->
12-
- [ ] Feature request
13-
- [ ] Performance issue
14-
- [ ] Regression (a behavior that used to work and stopped working in a new release)
15-
- [ ] Documentation issue or request
16-
- [ ] Other... Please describe:
11+
<!--
12+
E.g.
13+
bug report,
14+
feature request,
15+
performance issue,
16+
regression (a behavior that used to work and stopped working in a new release),
17+
documentation issue or request,
18+
or others... (please describe)
19+
-->
1720

1821
## Current behavior
1922

@@ -29,7 +32,7 @@ ISSUES MISSING IMPORTANT INFORMATION MAY BE CLOSED WITHOUT INVESTIGATION.
2932
For bug reports please provide the *STEPS TO REPRODUCE* and if possible a *MINIMAL DEMO* of the problem via github repo or similar tools.
3033
-->
3134

32-
## What is the motivation / use case for changing the behavior?
35+
## What is the motivation / use case for changing the behavior
3336

3437
<!-- Describe the motivation or the concrete use case. -->
3538

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 15 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,25 @@ https://github.com/Armour/express-webpack-react-redux-typescript-boilerplate/blo
44
-->
55

66
<!-- PULL REQUEST TEMPLATE -->
7-
<!-- (Update "[ ]" to "[x]" to check a box) -->
87

9-
**What kind of change does this PR introduce?** (check at least one)
8+
**Make sure the PR fulfills these requirements:**
109

11-
- [ ] Bugfix
12-
- [ ] Feature
13-
- [ ] Code style update
14-
- [ ] Refactor
15-
- [ ] Build-related changes
16-
- [ ] Other, please describe:
10+
- When resolving a specific issue, make sure it's referenced in the PR's title (e.g. `Closes #xxx[,#xxx]`, where "xxx" is the issue number)
1711

18-
**Does this PR introduce a breaking change?** (check one)
12+
- If adding a **new feature**, the PR's description includes: A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it)
1913

20-
- [ ] Yes
21-
- [ ] No
14+
- If this PR introduce a **breaking change**, please describe the impact and migration path for existing applications
2215

23-
If yes, please describe the impact and migration path for existing applications:
16+
**What kind of change does this PR introduce?**
2417

25-
**The PR fulfills these requirements:**
26-
27-
- [ ] When resolving a specific issue, it's referenced in the PR's title (e.g. `Closes #xxx[,#xxx]`, where "xxx" is the issue number)
28-
29-
If adding a **new feature**, the PR's description includes:
30-
31-
- [ ] A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it)
18+
<!--
19+
E.g.
20+
bugfix,
21+
feature,
22+
code style update,
23+
refactor,
24+
build-related changes,
25+
or others... (please describe)
26+
-->
3227

33-
**Other information:**
28+
**More information:**

frontend/src/router.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import * as React from 'react';
2-
import { Route, Switch } from 'react-router-dom';
2+
import { Route, Switch } from 'react-router';
33

44
import 'materialize-css';
55
import 'sass/global';

package.json

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
"serve": "cross-env NODE_ENV=production nodemon --exec babel-node backend/server.js",
1919
"profile": "yarn clean && yarn dll && cross-env NODE_ENV=production webpack --config webpack.config.profile.babel.js",
2020
"eslint": "eslint -f codeframe \"**/*.js\"",
21-
"tslint": "tslint -t codeFrame \"**/*.tsx\"",
21+
"tslint": "tslint -t codeFrame \"**/*.tsx\" \"**/*.d.ts\" -e \"node_modules/**\"",
2222
"stylelint": "stylelint \"**/*.css **/*.sass **/*.scss\"",
2323
"lint": "yarn eslint && yarn tslint && yarn stylelint",
2424
"test": "jest --no-cache --coverage",
@@ -38,6 +38,7 @@
3838
"@types/react": "^16.4.9",
3939
"@types/react-dom": "^16.0.7",
4040
"@types/react-redux": "^6.0.6",
41+
"@types/react-router": "^4.0.30",
4142
"@types/react-router-dom": "^4.3.0",
4243
"@types/redux-logger": "^3.0.6",
4344
"@types/uuid": "^3.4.3",
@@ -57,7 +58,7 @@
5758
"compression": "^1.7.3",
5859
"concurrently": "^3.6.1",
5960
"connect-redis": "^3.3.3",
60-
"connected-react-router": "^4.3.0",
61+
"connected-react-router": "^4.4.1",
6162
"cookie-parser": "^1.4.3",
6263
"copy-webpack-plugin": "^4.5.2",
6364
"cross-env": "^5.2.0",
@@ -90,6 +91,7 @@
9091
"react-dom": "^16.4.2",
9192
"react-hot-loader": "^4.3.4",
9293
"react-redux": "^5.0.7",
94+
"react-router": "^4.3.1",
9395
"react-router-dom": "^4.3.1",
9496
"redux": "^4.0.0",
9597
"redux-logger": "^3.0.6",
@@ -105,17 +107,17 @@
105107
"webpack-bundle-analyzer": "^2.13.1",
106108
"webpack-cli": "^3.1.0",
107109
"webpack-merge": "^4.1.4",
108-
"webpack-pwa-manifest": "^3.6.3"
110+
"webpack-pwa-manifest": "^3.7.1"
109111
},
110112
"devDependencies": {
111113
"@types/jest": "^23.3.1",
112114
"commitlint": "^7.0.0",
113-
"commitlint-config-armour": "^1.2.0",
115+
"commitlint-config-armour": "^1.2.1",
114116
"coveralls": "^3.0.2",
115117
"eslint": "^5.3.0",
116118
"eslint-config-airbnb": "^17.0.0",
117119
"eslint-import-resolver-webpack": "^0.10.1",
118-
"eslint-plugin-import": "^2.13.0",
120+
"eslint-plugin-import": "^2.14.0",
119121
"eslint-plugin-jsx-a11y": "^6.1.1",
120122
"eslint-plugin-react": "^7.10.0",
121123
"husky": "1.0.0-rc.13",

tsconfig.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,10 @@
1919
"noUnusedParameters": true,
2020
"removeComments": true,
2121
"sourceMap": true,
22-
"strict": true,
22+
"strict": true
2323
},
2424
"exclude": [
25-
"node_modules"
25+
"node_modules",
26+
"**/*.spec.tsx"
2627
]
2728
}

tslint.json

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,5 @@
3737
true,
3838
"ban-keywords"
3939
]
40-
},
41-
"linterOptions": {
42-
"exclude": [
43-
"node_modules/**"
44-
]
4540
}
4641
}

yarn.lock

Lines changed: 42 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -191,8 +191,8 @@
191191
"@types/jquery" "*"
192192

193193
"@types/node@*":
194-
version "10.5.7"
195-
resolved "https://registry.yarnpkg.com/@types/node/-/node-10.5.7.tgz#960d9feb3ade2233bcc9843c918d740b4f78a7cf"
194+
version "10.5.8"
195+
resolved "https://registry.yarnpkg.com/@types/node/-/node-10.5.8.tgz#6f14ccecad1d19332f063a6a764f8907801fece0"
196196

197197
"@types/prismjs@^1.9.0":
198198
version "1.9.0"
@@ -226,7 +226,7 @@
226226
"@types/react" "*"
227227
"@types/react-router" "*"
228228

229-
"@types/react-router@*":
229+
"@types/react-router@*", "@types/react-router@^4.0.30":
230230
version "4.0.30"
231231
resolved "https://registry.yarnpkg.com/@types/react-router/-/react-router-4.0.30.tgz#64bcd886befd1f932779b74d17954adbefb7a3a7"
232232
dependencies:
@@ -764,11 +764,11 @@ autoprefixer@^8.6.5:
764764
postcss-value-parser "^3.2.3"
765765

766766
autoprefixer@^9.0.0:
767-
version "9.1.0"
768-
resolved "https://registry.yarnpkg.com/autoprefixer/-/autoprefixer-9.1.0.tgz#566a70d1148046b96b31efa08090f1999ffb6d8c"
767+
version "9.1.1"
768+
resolved "https://registry.yarnpkg.com/autoprefixer/-/autoprefixer-9.1.1.tgz#e4ffa96c71270b8a1967d1542abc5f8453920a77"
769769
dependencies:
770-
browserslist "^4.0.1"
771-
caniuse-lite "^1.0.30000872"
770+
browserslist "^4.0.2"
771+
caniuse-lite "^1.0.30000876"
772772
normalize-range "^0.1.2"
773773
num2fraction "^1.2.2"
774774
postcss "^7.0.2"
@@ -1875,13 +1875,13 @@ browserslist@^3.2.6, browserslist@^3.2.8:
18751875
caniuse-lite "^1.0.30000844"
18761876
electron-to-chromium "^1.3.47"
18771877

1878-
browserslist@^4.0.0, browserslist@^4.0.1:
1879-
version "4.0.1"
1880-
resolved "https://registry.yarnpkg.com/browserslist/-/browserslist-4.0.1.tgz#61c05ce2a5843c7d96166408bc23d58b5416e818"
1878+
browserslist@^4.0.0, browserslist@^4.0.2:
1879+
version "4.0.2"
1880+
resolved "https://registry.yarnpkg.com/browserslist/-/browserslist-4.0.2.tgz#294388f5844bb3ab15ef7394ca17f49bf7a4e6f1"
18811881
dependencies:
1882-
caniuse-lite "^1.0.30000865"
1883-
electron-to-chromium "^1.3.52"
1884-
node-releases "^1.0.0-alpha.10"
1882+
caniuse-lite "^1.0.30000876"
1883+
electron-to-chromium "^1.3.57"
1884+
node-releases "^1.0.0-alpha.11"
18851885

18861886
bser@^2.0.0:
18871887
version "2.0.0"
@@ -2070,9 +2070,9 @@ caniuse-api@^3.0.0:
20702070
lodash.memoize "^4.1.2"
20712071
lodash.uniq "^4.5.0"
20722072

2073-
caniuse-lite@^1.0.0, caniuse-lite@^1.0.30000844, caniuse-lite@^1.0.30000864, caniuse-lite@^1.0.30000865, caniuse-lite@^1.0.30000872:
2074-
version "1.0.30000874"
2075-
resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30000874.tgz#a641b1f1c420d58d9b132920ef6ba87bbdcd2223"
2073+
caniuse-lite@^1.0.0, caniuse-lite@^1.0.30000844, caniuse-lite@^1.0.30000864, caniuse-lite@^1.0.30000865, caniuse-lite@^1.0.30000876:
2074+
version "1.0.30000876"
2075+
resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30000876.tgz#69fc1b696a35fd91089061aa916f677ee7057ada"
20762076

20772077
capture-exit@^1.2.0:
20782078
version "1.2.0"
@@ -2427,9 +2427,9 @@ commander@~2.8.1:
24272427
dependencies:
24282428
graceful-readlink ">= 1.0.0"
24292429

2430-
commitlint-config-armour@^1.2.0:
2431-
version "1.2.0"
2432-
resolved "https://registry.yarnpkg.com/commitlint-config-armour/-/commitlint-config-armour-1.2.0.tgz#78545dc752f7314c903b2c26d54bc7139896eb97"
2430+
commitlint-config-armour@^1.2.1:
2431+
version "1.2.1"
2432+
resolved "https://registry.yarnpkg.com/commitlint-config-armour/-/commitlint-config-armour-1.2.1.tgz#f80124d52a0936c099ecd4081acfba818a53630e"
24332433
dependencies:
24342434
"@commitlint/cli" "7.0.0"
24352435

@@ -2548,12 +2548,11 @@ connect-redis@^3.3.3:
25482548
debug "^3.1.0"
25492549
redis "^2.1.0"
25502550

2551-
connected-react-router@^4.3.0:
2552-
version "4.3.0"
2553-
resolved "https://registry.yarnpkg.com/connected-react-router/-/connected-react-router-4.3.0.tgz#a3bcba9e82ec5ee9f2018daeeddca827a7ef6235"
2551+
connected-react-router@^4.4.1:
2552+
version "4.4.1"
2553+
resolved "https://registry.yarnpkg.com/connected-react-router/-/connected-react-router-4.4.1.tgz#352ad5340ca3d296e7ebac14adcf789eb8a20e0c"
25542554
dependencies:
25552555
immutable "^3.8.1"
2556-
react-router "^4.2.0"
25572556

25582557
console-browserify@^1.1.0:
25592558
version "1.1.0"
@@ -3541,7 +3540,7 @@ ejs@^2.3.4, ejs@^2.5.7:
35413540
version "2.6.1"
35423541
resolved "https://registry.yarnpkg.com/ejs/-/ejs-2.6.1.tgz#498ec0d495655abc6f23cd61868d926464071aa0"
35433542

3544-
electron-to-chromium@^1.3.47, electron-to-chromium@^1.3.52:
3543+
electron-to-chromium@^1.3.47, electron-to-chromium@^1.3.57:
35453544
version "1.3.57"
35463545
resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.3.57.tgz#61b2446f16af26fb8873210007a7637ad644c82d"
35473546

@@ -3682,8 +3681,8 @@ escodegen@^1.9.1:
36823681
source-map "~0.6.1"
36833682

36843683
eslint-config-airbnb-base@^13.0.0:
3685-
version "13.0.0"
3686-
resolved "https://registry.yarnpkg.com/eslint-config-airbnb-base/-/eslint-config-airbnb-base-13.0.0.tgz#2ee6279c4891128e49d6445b24aa13c2d1a21450"
3684+
version "13.1.0"
3685+
resolved "https://registry.yarnpkg.com/eslint-config-airbnb-base/-/eslint-config-airbnb-base-13.1.0.tgz#b5a1b480b80dfad16433d6c4ad84e6605052c05c"
36873686
dependencies:
36883687
eslint-restricted-globals "^0.1.1"
36893688
object.assign "^4.1.0"
@@ -3726,9 +3725,9 @@ eslint-module-utils@^2.2.0:
37263725
debug "^2.6.8"
37273726
pkg-dir "^1.0.0"
37283727

3729-
eslint-plugin-import@^2.13.0:
3730-
version "2.13.0"
3731-
resolved "https://registry.yarnpkg.com/eslint-plugin-import/-/eslint-plugin-import-2.13.0.tgz#df24f241175e312d91662dc91ca84064caec14ed"
3728+
eslint-plugin-import@^2.14.0:
3729+
version "2.14.0"
3730+
resolved "https://registry.yarnpkg.com/eslint-plugin-import/-/eslint-plugin-import-2.14.0.tgz#6b17626d2e3e6ad52cfce8807a845d15e22111a8"
37323731
dependencies:
37333732
contains-path "^0.1.0"
37343733
debug "^2.6.8"
@@ -5346,8 +5345,8 @@ ignore@^3.3.5:
53465345
resolved "https://registry.yarnpkg.com/ignore/-/ignore-3.3.10.tgz#0a97fb876986e8081c631160f8f9f389157f0043"
53475346

53485347
ignore@^4.0.0, ignore@^4.0.2:
5349-
version "4.0.5"
5350-
resolved "https://registry.yarnpkg.com/ignore/-/ignore-4.0.5.tgz#333535a20325ba4852c4ddb135d47392aa035e6d"
5348+
version "4.0.6"
5349+
resolved "https://registry.yarnpkg.com/ignore/-/ignore-4.0.6.tgz#750e3db5862087b4737ebac8207ffd1ef27b25fc"
53515350

53525351
image-webpack-loader@^4.3.1:
53535352
version "4.3.1"
@@ -7490,9 +7489,9 @@ node-pre-gyp@^0.10.0:
74907489
semver "^5.3.0"
74917490
tar "^4"
74927491

7493-
node-releases@^1.0.0-alpha.10:
7494-
version "1.0.0-alpha.10"
7495-
resolved "https://registry.yarnpkg.com/node-releases/-/node-releases-1.0.0-alpha.10.tgz#61c8d5f9b5b2e05d84eba941d05b6f5202f68a2a"
7492+
node-releases@^1.0.0-alpha.11:
7493+
version "1.0.0-alpha.11"
7494+
resolved "https://registry.yarnpkg.com/node-releases/-/node-releases-1.0.0-alpha.11.tgz#73c810acc2e5b741a17ddfbb39dfca9ab9359d8a"
74967495
dependencies:
74977496
semver "^5.3.0"
74987497

@@ -7768,8 +7767,8 @@ onetime@^2.0.0:
77687767
mimic-fn "^1.0.0"
77697768

77707769
opener@^1.4.3:
7771-
version "1.4.3"
7772-
resolved "https://registry.yarnpkg.com/opener/-/opener-1.4.3.tgz#5c6da2c5d7e5831e8ffa3964950f8d6674ac90b8"
7770+
version "1.5.0"
7771+
resolved "https://registry.yarnpkg.com/opener/-/opener-1.5.0.tgz#24222fb4ad423ba21f5bf38855cebe44220f6531"
77737772

77747773
opn@^5.1.0:
77757774
version "5.3.0"
@@ -9206,7 +9205,7 @@ react-router-dom@^4.3.1:
92069205
react-router "^4.3.1"
92079206
warning "^4.0.1"
92089207

9209-
react-router@^4.2.0, react-router@^4.3.1:
9208+
react-router@^4.3.1:
92109209
version "4.3.1"
92119210
resolved "https://registry.yarnpkg.com/react-router/-/react-router-4.3.1.tgz#aada4aef14c809cb2e686b05cee4742234506c4e"
92129211
dependencies:
@@ -11642,9 +11641,9 @@ webpack-merge@^4.1.4:
1164211641
dependencies:
1164311642
lodash "^4.17.5"
1164411643

11645-
webpack-pwa-manifest@^3.6.3:
11646-
version "3.6.3"
11647-
resolved "https://registry.yarnpkg.com/webpack-pwa-manifest/-/webpack-pwa-manifest-3.6.3.tgz#519da004b0060f874ec7acdc838caed3f90061d5"
11644+
webpack-pwa-manifest@^3.7.1:
11645+
version "3.7.1"
11646+
resolved "https://registry.yarnpkg.com/webpack-pwa-manifest/-/webpack-pwa-manifest-3.7.1.tgz#ef3ca4571b1f799a470225be537c0ca6a1ac9505"
1164811647
dependencies:
1164911648
css-color-names "0.0.4"
1165011649
jimp "^0.2.28"
@@ -11699,10 +11698,10 @@ websocket-extensions@>=0.1.1:
1169911698
resolved "https://registry.yarnpkg.com/websocket-extensions/-/websocket-extensions-0.1.3.tgz#5d2ff22977003ec687a4b87073dfbbac146ccf29"
1170011699

1170111700
whatwg-encoding@^1.0.1, whatwg-encoding@^1.0.3:
11702-
version "1.0.3"
11703-
resolved "https://registry.yarnpkg.com/whatwg-encoding/-/whatwg-encoding-1.0.3.tgz#57c235bc8657e914d24e1a397d3c82daee0a6ba3"
11701+
version "1.0.4"
11702+
resolved "https://registry.yarnpkg.com/whatwg-encoding/-/whatwg-encoding-1.0.4.tgz#63fb016b7435b795d9025632c086a5209dbd2621"
1170411703
dependencies:
11705-
iconv-lite "0.4.19"
11704+
iconv-lite "0.4.23"
1170611705

1170711706
whatwg-fetch@>=0.10.0:
1170811707
version "2.0.4"

0 commit comments

Comments
 (0)