Name | Github | |
---|---|---|
์ด์ ์ | https://github.com/sxxk2 | [email protected] |
๊นํํฌ | https://github.com/nmdkims | [email protected] |
๊ณ ํฌ์ | https://github.com/GoHeeSeok00 | [email protected] |
๊น์๋ฐฑ | https://github.com/tkdqor | [email protected] |
๊น๋ฏผ์ง | https://github.com/my970524 | [email protected] |
2022.06.27 ~ 2022.07.29
- ๋ชจ๋ ํ์๋ค์ ๋์ผํ commit message template์ ์ค์ ํ๊ณ ๋ฐ๋ฆ ๋๋ค.
# --- ์ ๋ชฉ(title) - 50์ ์ด๋ด๋ก ---
# <ํ์
(type)> <์ ๋ชฉ(title)>
# ์์(ex) : Docs : #1 README.md ์์
# --- ๋ณธ๋ฌธ(content) - 72์๋ง๋ค ์ค๋ฐ๊พธ๊ธฐ ---
# ์์(ex) :
# - Workflow
# 1. ์ปค๋ฐ ๋ฉ์์ง์ ๋ํ ๋ฌธ์ ์ ์ ์ถ๊ฐ.
# 2. commit message docs add.
# --- ๊ผฌ๋ฆฌ๋ง(footer) ---
# <ํ์
(type)> <์ด์ ๋ฒํธ(issue number)>
# ์์(ex) : Fix #122
# --- COMMIT END ---
# <ํ์
> ๋ฆฌ์คํธ
# Init : ์ด๊ธฐํ
# Feat : ๊ธฐ๋ฅ์ถ๊ฐ
# Add : ๋ด์ฉ์ถ๊ฐ
# Update : ๊ธฐ๋ฅ ๋ณด์ (์
๊ทธ๋ ์ด๋)
# Fix : ๋ฒ๊ทธ ์์
# Refactor: ๋ฆฌํฉํ ๋ง
# Style : ์คํ์ผ (์ฝ๋ ํ์, ์ธ๋ฏธ์ฝ๋ก ์ถ๊ฐ: ๋น์ฆ๋์ค ๋ก์ง์ ๋ณ๊ฒฝ ์์)
# Docs : ๋ฌธ์ (README.md, ignoreํ์ผ ์ถ๊ฐ(Add), ์์ , ์ญ์ )
# Test : ํ
์คํธ (ํ
์คํธ ์ฝ๋ ์ถ๊ฐ, ์์ , ์ญ์ : ๋น์ฆ๋์ค ๋ก์ง์ ๋ณ๊ฒฝ ์์)
# Chore : ๊ธฐํ ๋ณ๊ฒฝ์ฌํญ (๋น๋ ์คํฌ๋ฆฝํธ ์์ ๋ฑ)
# Rename : ์ด๋ฆ(ํ์ผ๋ช
, ํด๋๋ช
, ๋ณ์๋ช
๋ฑ)์ ์์ ํ๊ฑฐ๋ ์ฎ๊ธฐ๋ ์์
๋ง์ธ ๊ฒฝ์ฐ
# Remove : ํ์ผ์ ์ญ์ ํ๋ ์์
๋ง ์ํํ ๊ฒฝ์ฐ
# ------------------
# ์ ๋ชฉ ์ฒซ ๊ธ์๋ฅผ ๋๋ฌธ์๋ก
# ์ ๋ชฉ์ ๋ช
๋ น๋ฌธ์ผ๋ก
# ์ ๋ชฉ ๋์ ๋ง์นจํ(.) ๊ธ์ง
# ์ ๋ชฉ๊ณผ ๋ณธ๋ฌธ์ ํ ์ค ๋์ ๋ถ๋ฆฌํ๊ธฐ
# ๋ณธ๋ฌธ์ "์ด๋ป๊ฒ" ๋ณด๋ค "๋ฌด์์", "์"๋ฅผ ์ค๋ช
ํ๋ค.
# ๋ณธ๋ฌธ์ ์ฌ๋ฌ ์ค์ ๋ฉ์์ง๋ฅผ ์์ฑํ ๋ "-" ํน์ "๋ฒํธ"๋ก ๊ตฌ๋ถ
# ------------------
-
main-feature ์ ๊ตฌ์ฑ์ ๋ฐ๋ฆ ๋๋ค.
ํ์ ๋ฉค๋ฒ๋ ๊ฐ์์ ์์ ๋ด์ฉ์ ๋ง๋ feature ๋ธ๋์น๋ฅผ ๋ง๋ค์ด์ ์์ ์ ์งํํฉ๋๋ค.
์์ ์ด ๋๋๋ฉด ๊ณต์ฉ ๋ธ๋์น์ธ main ๋ธ๋์น์ ์์ ์๋ฃ๋ ๋ด์ฉ์ ๋ณํฉ์ํค๊ฒ ๋ค๋ ๋ด์ฉ์ ํ์๋ค์๊ฒ ์๋ฆฌ๊ณ ๋ณํฉ์ ์งํํ๋ฉด ๋๊ฒ ์ต๋๋ค. -
feature/์ด์๋ฒํธ
๊ฐ์ ๋งก์ ๊ธฐ๋ฅ์ ๊ฐ๋ฐํ๋ ๋ธ๋์น ์ ๋๋ค.
๋ธ๋์น ์ด๋ฆ์ feature/์ด์๋ฒํธ๋ก ํ๊ณ , ์์ ์ด ์๋ฃ๋๋ฉด pull request๋ฅผ ์งํํ์ฌ main ๋ธ๋์น๋ก ๋ณํฉํฉ๋๋ค. -
main
๋ชจ๋ ๋ด์ฉ์ด ๋ฌธ์ ๊ฐ ์์ ๊ฒฝ์ฐ์๋ main ๋ธ๋์น๋ก ์ฝ๋๋ฅผ ๋ณํฉ์์ผ์ ๋ณด๊ดํฉ๋๋ค.
โ๏ธ Pull request & Merge ๊ท์น โ๏ธ
- Pull request์ Merge๋ ๋ค๋ฅธ ์ฌ๋์ด ํ๋๋ก
- Mergeํ๊ธฐ ์ ์ Pull request์ฝ๋ ํ์ธํ๊ณ ๋ฆฌ๋ทฐ ๋จ๊ธฐ๊ธฐ
- Class
- Pascal case
- Model
- snake case
- Function
- snake case
- Variables
- snake case
- Class, Function์ ์ฃผ์์ class, function ํ๋จ์ ์์ฑ
- ์ฃผ์์ผ๋ก Assignee ์์ฑ
- API์ ๊ฒฝ์ฐ, ์๋จ์ ์ฃผ์์ผ๋ก url ์ฃผ์ ์์ฑ
<example>
# api/v1/jobs/<int:id>/run
class JobTaskView(APIView):
"""
Assignee : ๊น์๋ฌด๊ฐ
"""
"""
์ฌ๋ฌ ์ค์ธ ๊ฒฝ์ฐ
์ด์๊ฐ์ด ์ฃผ์์
๋ต๋๋ค.
๋๋ฌด ๊ธธ์ง ์๊ฒ ์์ฑํฉ๋๋ค.
"""
"""ํ์ค๋ก ์์ฑ์์๋ ์ด์๊ฐ์ด ์์ฑ"""