-
Notifications
You must be signed in to change notification settings - Fork 5
Ground_Rule
yeji9175 edited this page Nov 18, 2020
·
1 revision
์จ์ผ ๋ธ๋ผ์ฐ์ ํ์ฅ์ฑ๊ณผ ์ฐ๋๋ ์ง๋ฅํ ํ ์ผ๊ด๋ฆฌ ์๋น์ค ๊ฐ๋ฐ A ๊ทธ๋ผ์ด๋ ๋ฃฐ
https://junwoo45.github.io/2020-02-06-commit_template/
- ์ปค๋ฐ ์์ ์ปค๋ฐ ์นดํ
๊ณ ๋ฆฌ๋ฅผ ๋๊ดํธ๋ก ๊ฐ์ธ์ฃผ๊ธฐ
- ex) [feat] something
- ๋ด์ฉ: "~๋ฅผ ์ํ ~ ๊ฐ๋ฐ"
- ex) [feat] something
# [ํ์
] <์ ๋ชฉ>
##### ์ ๋ชฉ์ ์ต๋ 50 ๊ธ์๊น์ง๋ง ์
๋ ฅ ############## -> |
# ๋ณธ๋ฌธ์ ์์ ์์ฑ
######## ๋ณธ๋ฌธ์ ํ ์ค์ ์ต๋ 72 ๊ธ์๊น์ง๋ง ์
๋ ฅ ########################### -> |
# ๊ผฌ๋ฆฟ๋ง์ ์๋์ ์์ฑ: ex) #์ด์ ๋ฒํธ
# --- COMMIT END ---
# <ํ์
> ๋ฆฌ์คํธ
# feat : ๊ธฐ๋ฅ (์๋ก์ด ๊ธฐ๋ฅ)
# fix : ๋ฒ๊ทธ (๋ฒ๊ทธ ์์ )
# refactor: ๋ฆฌํฉํ ๋ง
# style : ์คํ์ผ (์ฝ๋ ํ์, ์ธ๋ฏธ์ฝ๋ก ์ถ๊ฐ: ๋น์ฆ๋์ค ๋ก์ง์ ๋ณ๊ฒฝ ์์)
# docs : ๋ฌธ์ (๋ฌธ์ ์ถ๊ฐ, ์์ , ์ญ์ )
# test : ํ
์คํธ (ํ
์คํธ ์ฝ๋ ์ถ๊ฐ, ์์ , ์ญ์ : ๋น์ฆ๋์ค ๋ก์ง์ ๋ณ๊ฒฝ ์์)
# chore : ๊ธฐํ ๋ณ๊ฒฝ์ฌํญ (๋น๋ ์คํฌ๋ฆฝํธ ์์ ๋ฑ)
# ------------------
# ์ ๋ชฉ ์ฒซ ๊ธ์๋ฅผ ๋๋ฌธ์๋ก
# ์ ๋ชฉ์ ๋ช
๋ น๋ฌธ์ผ๋ก
# ์ ๋ชฉ ๋์ ๋ง์นจํ(.) ๊ธ์ง
# ์ ๋ชฉ๊ณผ ๋ณธ๋ฌธ์ ํ ์ค ๋์ ๋ถ๋ฆฌํ๊ธฐ
# ๋ณธ๋ฌธ์ "์ด๋ป๊ฒ" ๋ณด๋ค "๋ฌด์์", "์"๋ฅผ ์ค๋ช
ํ๋ค.
# ๋ณธ๋ฌธ์ ์ฌ๋ฌ์ค์ ๋ฉ์์ง๋ฅผ ์์ฑํ ๋ "-"๋ก ๊ตฌ๋ถ
# ------------------
- PR ํ๋์ commit ํ๋๋ง ๋ณด๋ด๋ ๊ฒ์ ์ง์ํด์ผ ํ๋ค.
- CLIENT, SERVER, IOS ํ๊ธฐํ๊ธฐ
- FIX์ธ ๊ฒฝ์ฐ์๋ง FIX๋ฅผ ์ถ๊ฐ
[CLIENT #์ด์๋ฒํธ (FIX)] PR ์ ๋ชฉ
## ๊ตฌํ์๋
- ์ถ์ํ ์๋(์ฌ์ฌ์ฉ์ฑ, ์ธํฐํ์ด์ค, etc...)
- ํจ์ ๊ตฌ๋ถ ๊ธฐ์ค
- ํด๋์ค ๊ณ์ธต๊ตฌ์กฐ
- Class, Struct, Object์ ์ฌ์ฉ ์๋
## ๊ธฐ๋ฅ ํ๋ฆ๋, ํด๋์ค ๋ค์ด์ด๊ทธ๋จ(์ ํ์ฌํญ)
## ์ฌ์ฉ๋ ๊ธฐ์
- ์คํ์์ค ๋ผ์ด๋ธ๋ฌ๋ฆฌ
- ๋ผ์ด๋ธ๋ฌ๋ฆฌ๋ฅผ ์ ์ผ๋๊ฐ?
## ๋ฆฌ๋ทฐ์์ฒญ & ๋
ผ์์ฌํญ & ๊ถ๊ธํ์
- A ๋ถ๋ถ์ ๋ ๊น๋ํ ๋ฐฉ์์ด ์์๊น ๊ถ๊ธํ๋ค.
- B ํด๋์ค๋ช
์ ๊ด์ฐฎ์ ์ง ๊ถ๊ธํ๋ค.
- develop/server, develop/web, develop/ios ๋ถ๋ฆฌํด์ ๊ด๋ฆฌํ๊ธฐ
- ํ์ ์ ์ด๋ป๊ฒ ํ์๋์ง
-
BE ํ์ผ์ด๋ฆ์ .์ผ๋ก ๋ชจ๋ธ๊ณผ ๊ธฐ๋ฅ์ ๊ตฌ๋ฌธํ์ฌ ์ฌ์ฉ
- ex) issue.controller.js
-
Class ๋๋ฌธ์๋ก ์์ํ๋
PascalCase
-
ํ์ผ, ๋ณ์์ด๋ฆ์ ์๋ฌธ์๋ก ์์ํ๊ณ
camelCase
-
ํด๋ ์ด๋ฆ
snake_case
-
DB ํ ์ด๋ธ๋ช , ์ดํธ๋ฆฌ๋ทฐํธ๋ช
snake_case
์ฌ์ฉ
- Prettier
{
"singleQuote": true,
"tabWidth": 2,
"trailingComma": "es5",
"bracketSpacing": true,
"printWidth": 100
}
- ESLint airbnb style guide ์ฌ์ฉ
- ํ๊ฒฝ์ค์ ํ์ผ์ ๊ท์น ์ถ๊ฐ๋ก ์ปค์คํ
- early ๋ฆฌํด ๊ถ์ฅ
{
if(){
return ...;
}
...
...
...
return ...;
}
- if ์ฌ์ฉ์ ์ค๊ดํธ{} ํ์
- ๋ณ์ ๋ฐ ํจ์๋ช
์ ๊ธธ์ด์ง๋๋ผ๋ ๊ตฌ์ฒด์ ์ผ๋ก ์์ฑ
- ์ผํญ ์ฐ์ฐ์ ์ฌ์ฉ์ ๊ถ์ฅํ๋ ์ฝ๋๊ฐ ๊ณผ๋ํ๊ฒ ๊ธธ์ด์ง ์ ์ฝ๋ ๋ถ๋ฆฌ
- ์ค์ฒฉ ์ผํญ ์ฐ์ฐ์๋ ์ง์
- ๊ตฌ์กฐ๋ถํด ํ ๋น ์ ๊ทน ํ์ฉ
{
const {a, b, c} = req.body
}
Vue javascript MySQL, Redis, SQLite Express
ํ ์คํธ... JEST GitHub Action, Server ์๋๋ฐฐํฌ,
- ์ฐธ๊ณ ํ ๋งํ ํ๋ก์ ํธ, ๊นํ๋ธ todo ๋ฑ...
- ์จ์ผ๋ธ๋ผ์ฐ์ API์์ ์ด๋ค ์ ๋ณด๋ฅผ ๋ฐ์์ฌ ์ ์๋์ง ๊ถ๊ธ
- ์จ์ผ์ ํ์ฅ์ฑ์ผ๋ก ์ต์ข ์ ์ผ๋ก ๋ฑ๋กํ๋ ๊ฒ์ธ์ง...
- ios ์๊ตฌ์ฌํญ์ ์คํ์์ค ์ฌ์ฉ๋ถ๊ฐ๋ผ๊ณ ํ๋๋ฐ swiftlint ๋ ์ฌ์ฉํ๋ฉด ์๋ ๊น์?
- rxswift ์ mvvm ์จ๋ณด๋ฉด ์ด๋จ๊น์