Skip to content

Commit

Permalink
Docs(github): update github related docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Armour committed Jul 14, 2018
1 parent 14a53f7 commit 7820952
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 132 deletions.
2 changes: 1 addition & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ indent_style = space
indent_size = 2
indent_style = space

# Indentation override for all html files
# Indentation override for html files
[*.html]
indent_size = 2
indent_style = space
Expand Down
135 changes: 25 additions & 110 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -8,152 +8,94 @@

# SOURCE CODE
*.bat text eol=crlf
*.c text
*.cc text
*.coffee text
*.cpp text
*.css text
*.go text
*.h text
*.hh text
*.hpp text
*.html text
*.inc text
*.ini text
*.java text
*.js text
*.jsx text
*.ejs text
*.html text
*.less text
*.php text
*.proto text
*.py text
*.rb text
*.sass text
*.sass text
*.scss text
*.sh text eol=lf
*.sql text
*.styl text
*.ts text
*.tsx text
*.vue text
*.xml text
*.xhtml text

# DOCKER
*.dockerignore text
Dockerfile text

# COMPILED FILES
*.dll binary
*.dylib binary
*.exe binary
*.so binary

# DOCUMENTATION
*.markdown text
*.md text
*.mdwn text
*.mdown text
*.mkd text
*.mkdn text
*.mdtxt text
*.mdtext text
*.txt text
AUTHORS text
CHANGELOG text
CHANGES text
CONTRIBUTING text
COPYING text
copyright text
*COPYRIGHT* text
INSTALL text
license text
LICENSE text
NEWS text
readme text
*README* text
TODO text

# TEMPLATES
*.ejs text
*.haml text
*.jade text
*.tmpl text
*.twig text

# CONFIGS
*.babelrc text
*.bowerrc text
*.cnf text
*.conf text
*.config text
.editorconfig text
.gitattributes text
.gitconfig text
.gitignore text
.htaccess text
*.conf text
*.config text
*.json text
*.lock text
Procfile text
*.toml text
*.yaml text
*.yml text
Makefile text
makefile text

# LINTERS
.csslintrc text
.eslintrc text
.eslintignore text
.htmlhintrc text
.jscsrc text
.jshintrc text
.jshintignore text
.stylelintrc text
.stylelignore text

# GRAPHICS
*.ai binary
*.bmp binary
*.eps binary
*.gif binary
*.heic binary
*.ico binary
*.jng binary
*.jp2 binary
*.jpg binary
*.jpeg binary
*.jpx binary
*.jxr binary
*.jpg binary
*.pdf binary
*.png binary
*.psb binary
*.psd binary
*.svg text
*.svgz binary
*.tif binary
*.tiff binary
*.wbmp binary
*.webp binary

# AUDIO
*.kar binary
*.aac binary
*.flac binary
*.m4a binary
*.mid binary
*.midi binary
*.mp3 binary
*.mp4a binary
*.mpga binary
*.oga binary
*.ogg binary
*.ra binary
*.wav binary
*.weba binary

# VIDEO
*.3gpp binary
*.3g2 binary
*.3gp binary
*.as binary
*.asf binary
*.asx binary
*.avi binary
*.f4v binary
*.fla binary
*.flv binary
*.m4v binary
*.mng binary
*.mov binary
*.mp4 binary
*.mpeg binary
*.mpg binary
*.ogv binary
*.swc binary
*.qt binary
*.swf binary
*.webm binary

Expand All @@ -166,35 +108,8 @@ makefile text
*.zip binary

# FONTS
*.ttf binary
*.eot binary
*.otf binary
*.ttf binary
*.woff binary
*.woff2 binary

# Compiled Object files
*.slo binary
*.lo binary
*.o binary
*.obj binary

# Precompiled Headers
*.gch binary
*.pch binary

# Compiled Dynamic libraries
*.so binary
*.dylib binary
*.dll binary

# Compiled Static libraries
*.lai binary
*.la binary
*.a binary
*.lib binary

# EXECUTABLES
*.exe binary
*.pyc binary
*.out binary

28 changes: 9 additions & 19 deletions .github/COMMIT_CONVENTION.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
Messages must be matched by the following regex:

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

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

Must be one of the following:

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

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.

* `Examples`
* `Feature`
* `Fix`
* `Performance`
* `Improvement`
* `Security`
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.

### Scope

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ ISSUES MISSING IMPORTANT INFORMATION MAY BE CLOSED WITHOUT INVESTIGATION.
## Minimal reproduction of the problem with instructions

<!--
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.
For bug reports please provide the *STEPS TO REPRODUCE* and if possible a *MINIMAL DEMO* of the problem via github repo or similar tools.
-->

## What is the motivation / use case for changing the behavior?
Expand Down
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ If yes, please describe the impact and migration path for existing applications:

**The PR fulfills these requirements:**

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

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

Expand Down

0 comments on commit 7820952

Please sign in to comment.