Skip to content

Commit

Permalink
docs: add STYLE_GUIDE.md and update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sykim-etri committed May 11, 2021
1 parent 411c7e4 commit c7d25a6
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,5 @@ $ swag init


## Contribution
Learn how to start contribution on the [Contributing Guideline](https://github.com/cloud-barista/docs/tree/master/contributing)
Learn how to start contribution on the [Contributing Guideline](https://github.com/cloud-barista/docs/tree/master/contributing) and [Style Guideline](https://github.com/cloud-barista/cb-ladybug/blob/master/STYLE_GUIDE.md)

26 changes: 26 additions & 0 deletions STYLE_GUIDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@

This document is under work-in-progress.

# Git Commit Message Style

## Commit Messages

### Message Structure
```
type: subject
body
footer
```

### The Type
* feat: a new feature
* fix: a bug fix
* docs: changes to documentation
* style: formatting, missing semi colons, etc; no code change
* refactor: refactoring production code
* test: adding tests, refactoring test; no production code change
* chore: updating build tasks, package manager configs, etc; no production code change

### Other contents
Reference to Udacity Git Commit Message Style Guide
* <https://udacity.github.io/git-styleguide/> (engilish)

0 comments on commit c7d25a6

Please sign in to comment.