Skip to content

Ground_Rule

yeji9175 edited this page Nov 18, 2020 · 1 revision

์›จ์ผ ๋ธŒ๋ผ์šฐ์ € ํ™•์žฅ์•ฑ๊ณผ ์—ฐ๋™๋œ ์ง€๋Šฅํ˜• ํ• ์ผ๊ด€๋ฆฌ ์„œ๋น„์Šค ๊ฐœ๋ฐœ A ๊ทธ๋ผ์šด๋“œ ๋ฃฐ

์ปค๋ฐ‹ ์ปจ๋ฒค์…˜

https://junwoo45.github.io/2020-02-06-commit_template/

  • ์ปค๋ฐ‹ ์•ž์— ์ปค๋ฐ‹ ์นดํ…Œ๊ณ ๋ฆฌ๋ฅผ ๋Œ€๊ด„ํ˜ธ๋กœ ๊ฐ์‹ธ์ฃผ๊ธฐ
    • ex) [feat] something
      • ๋‚ด์šฉ: "~๋ฅผ ์œ„ํ•œ ~ ๊ฐœ๋ฐœ"
# [ํƒ€์ž…] <์ œ๋ชฉ>

##### ์ œ๋ชฉ์€ ์ตœ๋Œ€ 50 ๊ธ€์ž๊นŒ์ง€๋งŒ ์ž…๋ ฅ ############## -> |


# ๋ณธ๋ฌธ์€ ์œ„์— ์ž‘์„ฑ
######## ๋ณธ๋ฌธ์€ ํ•œ ์ค„์— ์ตœ๋Œ€ 72 ๊ธ€์ž๊นŒ์ง€๋งŒ ์ž…๋ ฅ ########################### -> |

# ๊ผฌ๋ฆฟ๋ง์€ ์•„๋ž˜์— ์ž‘์„ฑ: ex) #์ด์Šˆ ๋ฒˆํ˜ธ

# --- COMMIT END ---
# <ํƒ€์ž…> ๋ฆฌ์ŠคํŠธ
#   feat    : ๊ธฐ๋Šฅ (์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ)
#   fix     : ๋ฒ„๊ทธ (๋ฒ„๊ทธ ์ˆ˜์ •)
#   refactor: ๋ฆฌํŒฉํ† ๋ง
#   style   : ์Šคํƒ€์ผ (์ฝ”๋“œ ํ˜•์‹, ์„ธ๋ฏธ์ฝœ๋ก  ์ถ”๊ฐ€: ๋น„์ฆˆ๋‹ˆ์Šค ๋กœ์ง์— ๋ณ€๊ฒฝ ์—†์Œ)
#   docs    : ๋ฌธ์„œ (๋ฌธ์„œ ์ถ”๊ฐ€, ์ˆ˜์ •, ์‚ญ์ œ)
#   test    : ํ…Œ์ŠคํŠธ (ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ถ”๊ฐ€, ์ˆ˜์ •, ์‚ญ์ œ: ๋น„์ฆˆ๋‹ˆ์Šค ๋กœ์ง์— ๋ณ€๊ฒฝ ์—†์Œ)
#   chore   : ๊ธฐํƒ€ ๋ณ€๊ฒฝ์‚ฌํ•ญ (๋นŒ๋“œ ์Šคํฌ๋ฆฝํŠธ ์ˆ˜์ • ๋“ฑ)
# ------------------
#     ์ œ๋ชฉ ์ฒซ ๊ธ€์ž๋ฅผ ๋Œ€๋ฌธ์ž๋กœ
#     ์ œ๋ชฉ์€ ๋ช…๋ น๋ฌธ์œผ๋กœ
#     ์ œ๋ชฉ ๋์— ๋งˆ์นจํ‘œ(.) ๊ธˆ์ง€
#     ์ œ๋ชฉ๊ณผ ๋ณธ๋ฌธ์„ ํ•œ ์ค„ ๋„์›Œ ๋ถ„๋ฆฌํ•˜๊ธฐ
#     ๋ณธ๋ฌธ์€ "์–ด๋–ป๊ฒŒ" ๋ณด๋‹ค "๋ฌด์—‡์„", "์™œ"๋ฅผ ์„ค๋ช…ํ•œ๋‹ค.
#     ๋ณธ๋ฌธ์— ์—ฌ๋Ÿฌ์ค„์˜ ๋ฉ”์‹œ์ง€๋ฅผ ์ž‘์„ฑํ•  ๋• "-"๋กœ ๊ตฌ๋ถ„
# ------------------

PR ์ปจ๋ฒค์…˜

  • PR ํ•˜๋‚˜์— commit ํ•˜๋‚˜๋งŒ ๋ณด๋‚ด๋Š” ๊ฒƒ์€ ์ง€์–‘ํ•ด์•ผ ํ•œ๋‹ค.
  • CLIENT, SERVER, IOS ํ‘œ๊ธฐํ•˜๊ธฐ
  • FIX์ธ ๊ฒฝ์šฐ์—๋งŒ FIX๋ฅผ ์ถ”๊ฐ€
[CLIENT #์ด์Šˆ๋ฒˆํ˜ธ (FIX)] PR ์ œ๋ชฉ

## ๊ตฌํ˜„์˜๋„

- ์ถ”์ƒํ™” ์˜๋„(์žฌ์‚ฌ์šฉ์„ฑ, ์ธํ„ฐํŽ˜์ด์Šค, etc...)
- ํ•จ์ˆ˜ ๊ตฌ๋ถ„ ๊ธฐ์ค€
- ํด๋ž˜์Šค ๊ณ„์ธต๊ตฌ์กฐ
- Class, Struct, Object์˜ ์‚ฌ์šฉ ์˜๋„

## ๊ธฐ๋Šฅ ํ๋ฆ„๋„, ํด๋ž˜์Šค ๋‹ค์ด์–ด๊ทธ๋žจ(์„ ํƒ์‚ฌํ•ญ)

## ์‚ฌ์šฉ๋œ ๊ธฐ์ˆ 

- ์˜คํ”ˆ์†Œ์Šค ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ
- ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ๋ฅผ ์™œ ์ผ๋Š”๊ฐ€?

## ๋ฆฌ๋ทฐ์š”์ฒญ & ๋…ผ์˜์‚ฌํ•ญ & ๊ถ๊ธˆํ•œ์ 

- A ๋ถ€๋ถ„์€ ๋” ๊น”๋”ํ•œ ๋ฐฉ์‹์ด ์žˆ์„๊นŒ ๊ถ๊ธˆํ•˜๋‹ค. 
- B ํด๋ž˜์Šค๋ช…์€ ๊ดœ์ฐฎ์€ ์ง€ ๊ถ๊ธˆํ•˜๋‹ค.

๋ธŒ๋žœ์น˜ ๊ด€๋ฆฌ ์ „๋žต

  • develop/server, develop/web, develop/ios ๋ถ„๋ฆฌํ•ด์„œ ๊ด€๋ฆฌํ•˜๊ธฐ

Fork ํ›„ ์ž‘์—… vs ๊ทธ๋ƒฅ ์ž‘์—…

  • ํ˜„์—…์— ์–ด๋–ป๊ฒŒ ํ•˜์‹œ๋Š”์ง€

์ฝ”๋”ฉ ์ปจ๋ฒค์…˜

WEB

  • 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 ์ž๋™๋ฐฐํฌ,

IOS

์งˆ๋ฌธ์‚ฌํ•ญ

  • ์ฐธ๊ณ ํ•  ๋งŒํ•œ ํ”„๋กœ์ ํŠธ, ๊นƒํ—ˆ๋ธŒ todo ๋“ฑ...
  • ์›จ์ผ๋ธŒ๋ผ์šฐ์ €API์—์„œ ์–ด๋–ค ์ •๋ณด๋ฅผ ๋ฐ›์•„์˜ฌ ์ˆ˜ ์žˆ๋Š”์ง€ ๊ถ๊ธˆ
  • ์›จ์ผ์— ํ™•์žฅ์•ฑ์œผ๋กœ ์ตœ์ข…์ ์œผ๋กœ ๋“ฑ๋กํ•˜๋Š” ๊ฒƒ์ธ์ง€...
  • ios ์š”๊ตฌ์‚ฌํ•ญ์— ์˜คํ”ˆ์†Œ์Šค ์‚ฌ์šฉ๋ถˆ๊ฐ€๋ผ๊ณ  ํ•˜๋Š”๋ฐ swiftlint ๋„ ์‚ฌ์šฉํ•˜๋ฉด ์•ˆ๋ ๊นŒ์š”?
  • rxswift ์™€ mvvm ์จ๋ณด๋ฉด ์–ด๋–จ๊นŒ์š”
Clone this wiki locally