Team Rules - codestates/pomodoro GitHub Wiki
Team Rules
- ๊ธฐํ ํ์๋ ์ ์ ์ฐธ์ํ๋ค.
- ์คํ 2์ ~ 6์๋ ํญ์ ์ฐ๋ฝ ๊ฐ๋ฅํ ์ํ๋ฅผ ์ ์งํ๋ค.
- ์์ ์ ๊ธฐํ ๋จ๊ณ์ ์ฌ์ฉํ ํ์ ํด์ ์ ๊ทน ์ด์ฉํ๋ค.
์์ ์ค ๊ธฐํ ๋ด์ฉ์ ์์ ์ฌํญ์ด ํ์ํ ๊ฒฝ์ฐ ํ์๋ค๊ณผ ํ ์ํ๋ค. ์ฃผ๋ง์ ์์ ๋กญ๊ฒ ์์ ํ๋ค.
๐ Commit Convention
Commit Header
- {commit header}: {commit title} (#{issue number})
Commit Body
์ปค๋ฐ ๋ฉ์์ง๋ ์ ๋ชฉ๊ณผ ๋ณธ๋ฌธ์ผ๋ก ๋๋์ด ์ง๋๋ค. ํ ์ค๋ง ์์ฑํด๋ ์ค๋ช ์ด ์ถฉ๋ถํ๋ค๋ฉด ์ ๋ชฉ๋ง์ผ๋ก๋ ๊ด์ฐฎ์ต๋๋ค. ํ์ง๋ง ์ด๋ค ๋ณ๊ฒฝ ์ฌํญ์ด ์๋์ง ๋งฅ๋ฝ๊ณผ ์ค๋ช ์ด ํ์ํ๋ค๋ฉด ๋ณธ๋ฌธ์ ์์ฑํ ์ ์์ต๋๋ค. ๋ค์์ ์ ๋ชฉ๊ณผ ๋ณธ๋ฌธ์ ์์ฑํ๋ ๊ท์น์ ๋๋ค.
- ์ ๋ชฉ๊ณผ ๋ณธ๋ฌธ์ ํ ์ค ๋์ ๋ถ๋ฆฌํด ์ฃผ์ธ์.
- ์ ๋ชฉ์ 50์ ์ด๋ด๋ก ์ ์ด์ฃผ์ธ์.
- ์ ๋ชฉ ์ฒซ๊ธ์๋ฅผ ๋๋ฌธ์๋ก ์ ์ด์ฃผ์ธ์.
- ์ ๋ชฉ ๋์ . ๋ ๊ธ์งํฉ๋๋ค.
- ์ ๋ชฉ์ ๋ช ๋ น์ด๋ก ์์ฑํฉ๋๋ค.
- ๋ณธ๋ฌธ์ 50์๋ง๋ค ์ค์ ๋ฐ๊ฟ์ฃผ์ธ์.
- ๋ณธ๋ฌธ์ ์ด๋ป๊ฒ ๋ณ๊ฒฝํ๋์ง ๋ณด๋ค ๋ฌด์์ ๋ณ๊ฒฝํ๋์ง, ์ ๋ณ๊ฒฝํ๋์ง ์ ๋ง์ถ์ด ์์ฑํ์ธ์.
- EX )
โจfeat: Something (#1)
- body1
- body2
Commit header ์ข ๋ฅ | ์ด๋ชจ์ง | Commit ํ์ | ์ค๋ช |
---|---|---|---|
New Feature | โจ:sparkles: |
feat: | ์๋ก์ด ๊ธฐ๋ฅ์ ๋ํ ์ปค๋ฐ |
Fix | :wrench::wrench: |
fix: | ๊ธฐ๋ฅ ์์ ์ ๋ํ ์ปค๋ฐ |
Bug | ๐:bug: |
bug: | ๋ฒ๊ทธ ๊ด๋ จ์ ๋ํ ์ปค๋ฐ |
Working In Process | โ:gear: |
wip: | ์งํ ์ค์ธ ์ฌํญ์ ๋ํ ์ปค๋ฐ |
Refactor Code | :broom: :broom: |
refactor: | ์ฝ๋ ๋ฌธ๋ฒ, ํฌ๋งท(prettier) ๋ฑ ๋ฆฌํฉํ ๋ง์ ๋ํ ์ปค๋ฐ |
Documentation | ๐ :books: |
docs: | ๋ํ๋จผํธ ์์ ์ ๋ํ ์ปค๋ฐ |
Styling UI | ๐จ:art: |
style: | HTML, CSS, ์คํ ์์ ์ ๋ํ ์ปค๋ฐ |
Package Manager | :key::key: |
build: | ํจํค์ง ๋งค๋์ ์ค์ ํ ๊ฒฝ์ฐ |
Test Code | :hourglass::hourglass: |
test: | ๋๋ฝ๋ ํ ์คํธ ์ถ๊ฐ ๋๋ ๊ธฐ์กด ํ ์คํธ ์์ |
Revert | :leftwards_arrow_with_hook::leftwards_arrow_with_hook: |
revert: | ์์ ๋๋๋ฆฌ๊ธฐ |
๐ Branch convention
upstream
์ข ๋ฅ | ์ฌ์ฉํจํด | ํน์ง |
---|---|---|
main |
main |
ํ๋ก๋์ ์ค๋ ์ท๊ฐ์ฅ ์ต์ ์ ๋ฐฐํฌ๋ ๋ฒ์ |
dev-front |
dev-front |
ํ๋ก ํธ์๋ ๋ฆด๋ฆฌ์ฆ ๊ณํ์ ๋ฐ๋ผ์ Github์์ ๊ธฐ๋ณธ ๋ธ๋์น๋ก ์ง์ |
dev-back |
dev-back |
๋ฐฑ์๋ ๋ฆด๋ฆฌ์ฆ ๊ณํ์ ๋ฐ๋ผ์ Github์์ ๊ธฐ๋ณธ ๋ธ๋์น๋ก ์ง์ |
origin (๊ฐ์ธ ํฌํฌ ๋ ํฌ์งํ ๋ฆฌ)
์ข ๋ฅ | ์ฌ์ฉํจํด | ํน์ง |
---|---|---|
feat |
feat/์ด์๋ฒํธ-ํ
์คํฌ์นด๋์ ๋ชฉ feat/1-Login_์ปดํฌ๋ํธ |
dev์ ๋ณํฉ๋์ด์ฐ๊ธฐ๋ ์ธ๋๋ฐ_ ๋ฅผ ์ฌ์ฉํ๋ค. |
fix |
fix/์ด์๋ฒํธ fix/#911 |
๋ฉ์ธ์ ๋ณํฉ |
Lint convention
- semistandard ๋ฅผ ๋ฐ๋ฆ ๋๋ค.
Prettier
๋ฅผ ์ฌ์ฉํฉ๋๋ค.
์ฃผ์ ๊ท์น
space
๋ ๋ ์นธ, ํญ ์ฌ์ฉ x- ์๋ฐ์คํฌ๋ฆฝํธ ์ฝ๋๋
single quote
์ํ ํ๋ฆฟ ๋ฆฌํฐ๋ด
์ ์ฌ์ฉํ๊ณ , ๋ ๋๋ง ๋ถ๋ถ HTML ์ฝ๋๋ double quote๋ฅผ ์ฌ์ฉํ๋ค. line-wrapping
์ 80์๋ฅผ ๊ธฐ์ค์ผ๋ก ํ๋ ๊ฒ์ ์์น์ผ๋ก ํฉ๋๋ค.var
๋ ์ฌ์ฉํ์ง ์์ต๋๋ค.- ํค์๋ ๋ค์์ ์คํ์ด์ค ํ๋๋ฅผ ๋์์ฃผ์ธ์.
- ๋ ๋ง์ ์ ๋ณด๋ https://standardjs.com/rules.html ๋ฅผ ์ฐธ๊ณ ํ์ธ์.
- ์ ๋งํฌ์ ๋ฃฐ์์ ์ค์ง ํ ๊ฐ์ง๋ง ์์ธ์ ๋๋ค. ์ธ๋ฏธ ์ฝ๋ก ์ฌ์ฉ์ ํ์ฉํฉ๋๋ค.
PR type
-
์ฝ๋ ์ปจ๋ฒค์ ์ ์ ์ง์ผ์ฃผ์ธ์. ์ปจ๋ฒค์ ์ค๋ฅ๋ก ์ธํ ๋ถํ์ํ ์ฝ๋ฉํธ๋ ์๊ฐ ๋ญ๋น์ด๊ธฐ ๋๋ฌธ์ ์ง์ํ๋ ๊ฒ์ด ์ข์ต๋๋ค.
-
๋ฆฌ๋ทฐ ๊ฐ์ด๋๋ผ์ธ์ ์ ์์ฑํด ์ฃผ์ธ์. ๋ชจ๋ ์ฝ๋ ๋ณ๊ฒฝ์ฌํญ์๋ ์๋๊ฐ ํ์ํฉ๋๋ค. ์๋์น ์๊ฒ ๋ณ๊ฒฝ๋ ๋ถ๋ถ์ด ์๋ค๋ฉด ๋๋๋ ค ๋์์ผ ํ๊ณ , ์ค๋ฐ๊ฟ๊ณผ ๊ฐ์ด ์์ฃผ ๋จ์ํ ๋ณ๊ฒฝ์ฌํญ์ด๋ผ๋ ๊ทธ ๋ถ๋ถ์ ๋ฆฌ๋ทฐ์ด๊ฐ ๋ณผ ํ์๊ฐ ์๋ค๋ฉด โJust line changeโ ์ ๊ฐ์ ์ฝ๋ฉํธ๋ฅผ ๋ฌ์ ๋ช ์ํ์ฌ ๋ฆฌ๋ทฐ ์๊ฐ์ ์ค์ฌ์ค ์ ์์ ๊ฒ์ ๋๋ค. ๋๋ ์ฌ์ฉ๋ ๋ผ์ด๋ธ๋ฌ๋ฆฌ ์ ๋ฐ์ดํธ๊ฐ ํฌํจ๋์๋ค๋ฉด ํด๋น ๋ผ์ด๋ธ๋ฌ๋ฆฌ์ ๋ฆด๋ฆฌ์ฆ ๋ ธํธ ๋งํฌ๋ ์คํฌ๋ฆฐ์ท์ ์ฒจ๋ถํ๋ ๊ฒ๋ ์ข์ ๋ฐฉ๋ฒ์ ๋๋ค.
-
์์ ์ค, ๋ฆฌ๋ทฐ ๊ฐ๋ฅ ์ฌ๋ถ๋ฅผ ์ ๋ช ์ํด ์ฃผ์ธ์. ์์ง ์ฝ๋๋ฅผ ์์ฑ ์ค์ผ ๋์๋ [WiP] (Work in Progress) ๋ฅผ ํ์ดํ ์์ ์ถ๊ฐํ๊ณ , ๋ง์ฝ ์์ ์ด ๋๋ฌ์ผ๋ฉด ์ด๋ฅผ ์ ๊ฑฐํ๊ณ review-needed ํ๊ทธ๋ฅผ ์ค์ ํ ์ ์์ต๋๋ค. ํ ๋ฒ ์์ ์ ๋ง์ณค๋ค๊ณ ๋๋ ๊ฒ์ด ์๋๊ธฐ ๋๋ฌธ์ ๋ฆฌ๋ทฐ๋ฅผ ๋ฐ์ํ๋ ์ค์๋ ์ด ๊ณผ์ ์ ๋ฐ๋ณตํ์ฌ ๋ช ์ํด ์ฃผ์ธ์.
-
PR ์ ๋ชฉ
Feat/์ด์๋ฒํธ ์นด๋์ ๋ชฉ
- PR ๋ณธ๋ฌธ
### PR ํ์
- [] ๊ธฐ๋ฅ ์ถ๊ฐ
- [] ๊ธฐ๋ฅ ์ญ์
- [] ๋ฒ๊ทธ ์์
- [] ์์กด์ฑ, ํ๊ฒฝ ๋ณ์, ๋น๋ ๊ด๋ จ ์ฝ๋ ์
๋ฐ์ดํธ
### ๋ฐ์ ๋ธ๋์น
feat/login -> dev-front
feat/login -> dev-back
### ๋ณ๊ฒฝ ์ฌํญ
๋ก๊ทธ์ธ ์, ๊ตฌ๊ธ ์์
๋ก๊ทธ์ธ ๊ธฐ๋ฅ์ ์ถ๊ฐํ์ต๋๋ค.
How to issue
- Issue ์ ๋ชฉ
[title] / body
- Issue ๋ณธ๋ฌธ
### Issue ํ์
-[] ๊ธฐ๋ฅ ์ถ๊ฐ
-[] ๊ธฐ๋ฅ ์ญ์
-[] ๋ฒ๊ทธ ์์
-[] ์์กด์ฑ, ํ๊ฒฝ ๋ณ์, ๋น๋ ๊ด๋ จ ์ฝ๋ ์
๋ฐ์ดํธ
### ์์ธ ๋ด์ฉ
- [ ] Github ์์
๋ก๊ทธ์ธ ๊ธฐ๋ฅ
- [ ] ๋ธ๋ผ๋ธ๋ผ
### Lables
- ๋ฉ์ธ ์ปค๋ฐ
- ์์
๋ถ์ผ(front or back)
- ์์์๊ฐ
- ์์ฒญ Issue ์ ๋ชฉ
๐ฃ[์์ฒญ] ๋ก๊ทธ์ธ ์ฟ ํค ๋ฌธ์
- ์์ฒญ Issue ๋ณธ๋ฌธ
### ์์ธ ๋ด์ฉ
๋ก๊ทธ์ธ ์ฟ ํค๊ฐ ๋ฐ์ ์์ง์ง ์์ต๋๋ค.
[img]์ฌ์ง ์ฒจ๋ถ(Optional)
### Lables
- request
- ์ฐ์ ์์
Name convention
๋ณ์ ์ด๋ฆ - Camel-case
ex) clientLogin
ํ์ผ & ์์ฑ์ ์ด๋ฆ - Pascal-case
ex) ClientSide
์์ ์ด๋ฆ Snake-case
ex) SNAKE_CASE
Stack version
Stack | Version |
---|---|
node | 16.13.1 LTS |
npm | 8.3 |
express | 4.17.1 |
mysql2 | 2.3.3 |
sequelize | 6.12.0-beta.3 |
sequelize-auto | 0.8.8 |
cookie-parser | 1.4.4 |
cors | 2.8.5 |
dotenv | 10.0.0 |
jsonwebtoken | 8.5.1 |
sequelize-cli | 6.3.0 |