Skip to content

Commit 7820952

Browse files
committed
Docs(github): update github related docs
1 parent 14a53f7 commit 7820952

File tree

5 files changed

+37
-132
lines changed

5 files changed

+37
-132
lines changed

.editorconfig

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ indent_style = space
2424
indent_size = 2
2525
indent_style = space
2626

27-
# Indentation override for all html files
27+
# Indentation override for html files
2828
[*.html]
2929
indent_size = 2
3030
indent_style = space

.gitattributes

+25-110
Original file line numberDiff line numberDiff line change
@@ -8,152 +8,94 @@
88

99
# SOURCE CODE
1010
*.bat text eol=crlf
11-
*.c text
12-
*.cc text
13-
*.coffee text
14-
*.cpp text
1511
*.css text
16-
*.go text
17-
*.h text
18-
*.hh text
19-
*.hpp text
20-
*.html text
21-
*.inc text
22-
*.ini text
23-
*.java text
2412
*.js text
2513
*.jsx text
14+
*.ejs text
15+
*.html text
2616
*.less text
27-
*.php text
28-
*.proto text
29-
*.py text
30-
*.rb text
31-
*.sass text
3217
*.sass text
3318
*.scss text
3419
*.sh text eol=lf
3520
*.sql text
36-
*.styl text
3721
*.ts text
3822
*.tsx text
39-
*.vue text
40-
*.xml text
41-
*.xhtml text
4223

4324
# DOCKER
4425
*.dockerignore text
4526
Dockerfile text
4627

28+
# COMPILED FILES
29+
*.dll binary
30+
*.dylib binary
31+
*.exe binary
32+
*.so binary
33+
4734
# DOCUMENTATION
48-
*.markdown text
4935
*.md text
50-
*.mdwn text
51-
*.mdown text
52-
*.mkd text
53-
*.mkdn text
54-
*.mdtxt text
55-
*.mdtext text
5636
*.txt text
57-
AUTHORS text
58-
CHANGELOG text
59-
CHANGES text
60-
CONTRIBUTING text
61-
COPYING text
62-
copyright text
63-
*COPYRIGHT* text
64-
INSTALL text
65-
license text
6637
LICENSE text
67-
NEWS text
68-
readme text
69-
*README* text
70-
TODO text
71-
72-
# TEMPLATES
73-
*.ejs text
74-
*.haml text
75-
*.jade text
76-
*.tmpl text
77-
*.twig text
7838

7939
# CONFIGS
80-
*.babelrc text
81-
*.bowerrc text
82-
*.cnf text
83-
*.conf text
84-
*.config text
8540
.editorconfig text
8641
.gitattributes text
87-
.gitconfig text
8842
.gitignore text
89-
.htaccess text
43+
*.conf text
44+
*.config text
9045
*.json text
9146
*.lock text
92-
Procfile text
47+
*.toml text
9348
*.yaml text
9449
*.yml text
95-
Makefile text
96-
makefile text
97-
98-
# LINTERS
99-
.csslintrc text
100-
.eslintrc text
101-
.eslintignore text
102-
.htmlhintrc text
103-
.jscsrc text
104-
.jshintrc text
105-
.jshintignore text
106-
.stylelintrc text
107-
.stylelignore text
10850

10951
# GRAPHICS
11052
*.ai binary
11153
*.bmp binary
11254
*.eps binary
11355
*.gif binary
56+
*.heic binary
11457
*.ico binary
115-
*.jng binary
116-
*.jp2 binary
117-
*.jpg binary
11858
*.jpeg binary
119-
*.jpx binary
120-
*.jxr binary
59+
*.jpg binary
12160
*.pdf binary
12261
*.png binary
12362
*.psb binary
12463
*.psd binary
12564
*.svg text
126-
*.svgz binary
12765
*.tif binary
12866
*.tiff binary
12967
*.wbmp binary
13068
*.webp binary
13169

13270
# AUDIO
133-
*.kar binary
71+
*.aac binary
72+
*.flac binary
13473
*.m4a binary
13574
*.mid binary
13675
*.midi binary
13776
*.mp3 binary
77+
*.mp4a binary
78+
*.mpga binary
79+
*.oga binary
13880
*.ogg binary
139-
*.ra binary
81+
*.wav binary
82+
*.weba binary
14083

14184
# VIDEO
142-
*.3gpp binary
85+
*.3g2 binary
14386
*.3gp binary
144-
*.as binary
14587
*.asf binary
146-
*.asx binary
88+
*.avi binary
89+
*.f4v binary
14790
*.fla binary
14891
*.flv binary
14992
*.m4v binary
150-
*.mng binary
15193
*.mov binary
15294
*.mp4 binary
15395
*.mpeg binary
15496
*.mpg binary
15597
*.ogv binary
156-
*.swc binary
98+
*.qt binary
15799
*.swf binary
158100
*.webm binary
159101

@@ -166,35 +108,8 @@ makefile text
166108
*.zip binary
167109

168110
# FONTS
169-
*.ttf binary
170111
*.eot binary
171112
*.otf binary
113+
*.ttf binary
172114
*.woff binary
173115
*.woff2 binary
174-
175-
# Compiled Object files
176-
*.slo binary
177-
*.lo binary
178-
*.o binary
179-
*.obj binary
180-
181-
# Precompiled Headers
182-
*.gch binary
183-
*.pch binary
184-
185-
# Compiled Dynamic libraries
186-
*.so binary
187-
*.dylib binary
188-
*.dll binary
189-
190-
# Compiled Static libraries
191-
*.lai binary
192-
*.la binary
193-
*.a binary
194-
*.lib binary
195-
196-
# EXECUTABLES
197-
*.exe binary
198-
*.pyc binary
199-
*.out binary
200-

.github/COMMIT_CONVENTION.md

+9-19
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
Messages must be matched by the following regex:
88

99
``` js
10-
/^(Revert: )?(Feature|Fix|Docs|Improvement|Config|Examples|Security|Style|Refactor|Performance|Test|Build|CI|Types)(\(.+\))?: .{1,80}/
10+
/^(Revert: )?(Feature|Fix|Docs|Improve|Config|Example|Refactor|Style|Test|Build|CI)(\(.+\))?: .{1,80}/
1111
```
1212

1313
## Commit Message Format
@@ -89,29 +89,19 @@ If the commit reverts a previous commit, it should begin with `Revert: `, follow
8989

9090
Must be one of the following:
9191

92-
* **Build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm, yarn)
93-
* **CI**: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
94-
* **Config**: Configuration changes
95-
* **Docs**: Documentation only changes
96-
* **Examples**: Changes for example code
92+
* **Build**: Changes that affect the build system or external dependencies (example scopes: gulp, npm, yarn)
93+
* **CI**: Changes to CI related configuration files and scripts (example scopes: travis, circle, browserstack)
94+
* **Config**: Changes to other configuration files (example scopes: webpack, babel, docker)
95+
* **Docs**: Documentation only changes (example scopes: readme, changelog)
96+
* **Example**: Changes for example code
9797
* **Feature**: A new feature
9898
* **Fix**: A bug fix
99-
* **Improvement**: Backwards-compatible enhancement changes
100-
* **Performance**: A code change that improves performance
99+
* **Improve**: Backwards-compatible enhancement changes
101100
* **Refactor**: A code change that neither fixes a bug nor adds a feature
102-
* **Security**: A security issue fix
103101
* **Style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
104-
* **Test**: Adding missing tests or correcting existing tests
105-
* **Types**: Typescript related changes
102+
* **Test**: Changes for testing code
106103

107-
If the prefix is in the below types, it will appear in the changelog. However if there is any [BREAKING CHANGE](#footer), the commit will always appear in the changelog.
108-
109-
* `Examples`
110-
* `Feature`
111-
* `Fix`
112-
* `Performance`
113-
* `Improvement`
114-
* `Security`
104+
If the prefix is `Feature` or `Fix`, it will appear in the changelog. However if there is any [BREAKING CHANGE](#footer), the commit will always appear in the changelog.
115105

116106
### Scope
117107

.github/ISSUE_TEMPLATE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ ISSUES MISSING IMPORTANT INFORMATION MAY BE CLOSED WITHOUT INVESTIGATION.
2626
## Minimal reproduction of the problem with instructions
2727

2828
<!--
29-
For bug reports please provide the *STEPS TO REPRODUCE* and if possible a *MINIMAL DEMO* of the problem via https://stackblitz.com, github repo or similar.
29+
For bug reports please provide the *STEPS TO REPRODUCE* and if possible a *MINIMAL DEMO* of the problem via github repo or similar tools.
3030
-->
3131

3232
## What is the motivation / use case for changing the behavior?

.github/PULL_REQUEST_TEMPLATE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ If yes, please describe the impact and migration path for existing applications:
2424

2525
**The PR fulfills these requirements:**
2626

27-
- [ ] When resolving a specific issue, it's referenced in the PR's title (e.g. `Fixes/Closes #xxx[,#xxx]`, where "xxx" is the issue number)
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)
2828

2929
If adding a **new feature**, the PR's description includes:
3030

0 commit comments

Comments
 (0)