Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

2 Commits
ย 
ย 

Repository files navigation

lotte-ecommerce-clean-code

๋กฏ๋ฐ ์ด์ปค๋จธ์Šค ์Šคํ„ฐ๋”” 3rd

๊ณต์ง€์‚ฌํ•ญ


  • ๋ฏธ์…˜ ๋‚ด์šฉ์„ ์™ธ๋ถ€์— ์œ ์ถœํ•˜์ง€ ๋ง์•„์ฃผ์„ธ์š”.
  • ํŽ˜์–ด๋ผ๋ฆฌ ๊ฐ์ž ๋ฏธ์…˜์„ ๊ตฌํ˜„ํ•ด์ฃผ์„ธ์š”. (์ ˆ๋Œ€๋กœ ๊ตฌ๊ธ€๋ง๋„ ์•ˆ๋ผ์š”)
  • ์ฝ”๋“œ๋ฆฌ๋ทฐ ์ „์—” ๋ณธ์ธ ํŒ€๊บผ ๊ตฌํ˜„ํ•˜๊ธฐ ์ „๊นŒ์ง„ ๋‹ค๋ฅธ์‚ฌ๋žŒ PR ์„ ํ›”์ณ๋ณด์ง€ ๋ง™์‹œ๋‹ค ! ! !
  • ํ˜น์‹œ๋ผ๋„ ํ›”์ณ๋ณด๊ฒŒ ๋๋‹ค๋ฉด ๋งˆ์Œ ์†์œผ๋กœ ์ž์ฑ…ํ•ฉ์‹œ๋‹ค.
  • ๊ฒฐ๊ตญ ํ•™์Šต์˜ ํ•ต์‹ฌ์€ ์ˆ˜๋™์ ์œผ๋กœ ํŽธํ•˜๊ฒŒ ์ •ํ•ด์ง„ ์ง€์‹๋งŒ ์Œ“์•„๊ฐ€๋А๋ƒ, ๋Šฅ๋™์ ์œผ๋กœ ๋ณธ์ธ์ด ์ฃผ์ฒด๊ฐ€ ๋˜์–ด ๊ฐˆ์ฆ๊ณผ ๊ถ๊ธˆ์ฆ์„ ๋А๋ผ๋Š” ์ง€์‹์„ ์Œ“์•„๊ฐ€๋А๋ƒ์—์„œ ์ฐจ์ด๊ฐ€ ๋ฒŒ์–ด์ง€๋Š”๋“ฏ ํ•ฉ๋‹ˆ๋‹ค.
  • ์ด๋ฒˆ ์Šคํ„ฐ๋””๊ฐ€ ๋Šฅ๋™์ ์œผ๋กœ ๋ณธ์ธ์ด ์ฃผ์ฒด๊ฐ€๋˜์–ด ๊ณต๋ถ€ํ•  ์ˆ˜ ์žˆ๋Š” ์Šคํ„ฐ๋””๊ฐ€ ๋œ๋‹ค๋ฉด ์ข‹๊ฒ ์Šต๋‹ˆ๋‹ค.
  • ์šฐ๋ฆฌ๊ฐ€ ๋‚˜๋ˆ„๋Š” ์ง€์‹๋“ค์ด ๋ชจ๋‘ ๊ณต์œ ๋˜๋Š”๊ฑธ ์ง€ํ–ฅํ•ฉ์‹œ๋‹ค.
  • ๊ฐ์ž ์˜ฌ๋ฆฌ๋Š” ์ •๋ณด ๊ณต์œ ๋‚˜ ์งˆ์˜ ์‘๋‹ต ๊ฐ™์€ ๊ฒƒ๋“ค์„ ์˜๋ฌด์ ์œผ๋กœ ๋‹ค๋“ค ํ•œ๋ฒˆ์”ฉ ์‚ดํŽด๋ณด๋ฉด ์ข‹๊ฒ ์Šต๋‹ˆ๋‹ค (์นดํ†ก์˜ ๊ฒฝ์šฐ์—” ์ด๋ชจ์ง€ ์ฒดํฌ, ์ฝ”๋“œ ๋ฆฌ๋ทฐ ์ฝ”๋ฉ˜ํŠธ๋Š” ํƒ€ ํŽ˜์–ด๊ฒƒ์ด๋ผ๋„ ๊ผญ ์ฝ๊ณ  ์ด๋ชจ์ง€ ๋•Œ๋ฆฝ์‹œ๋‹ค).

๋„์„œ


Clean Code(ํด๋ฆฐ ์ฝ”๋“œ) - ๊ต๋ณด๋ฌธ๊ณ 

๋กœ๋ฒ„ํŠธ C ๋งˆํ‹ด - ํด๋ฆฐ์ฝ”๋“œ ์Šคํ„ฐ๋””

์Šฌ๊ธฐ๋กœ์šด ์ฝ”๋“œ๋ฆฌ๋ทฐ์ƒํ™œ


11แ„‡แ…ฅแ†ซแ„€แ…ก แ„‡แ…ขแ†จแ„†แ…งแ†ผแ„‰แ…ฅแ†จ แ„แ…ฉแ„ƒแ…ณแ„…แ…ตแ„‡แ…ฒ แ„‰แ…ฆแ„†แ…ตแ„‚แ…ก.md

11๋ฒˆ๊ฐ€์˜ msa๋ฅผ ์„ฑ๊ณต์ ์œผ๋กœ ๋„์ž…ํ•œ ๋ฐฑ๋ช…์„๋‹˜์˜ ์ฝ”๋“œ๋ฆฌ๋ทฐ ์„ธ๋ฏธ๋‚˜ ๋‚ด์šฉ ์ •๋ฆฌ

ํ…์ŠคํŠธ์™€ ์ด๋ฏธ์ง€๋กœ ์‚ดํŽด๋ณด๋Š” ์˜จ๋ผ์ธ ์ฝ”๋“œ๋ฆฌ๋ทฐ ๊ณผ์ •


wwh-docs/README.md at master ยท wwh-techcamp-2018/wwh-docs

๋™์˜์ƒ์œผ๋กœ ๋ณด๊ณ  ์‹ถ๋‹ค๋ฉด


github์„ ๊ธฐ๋ฐ˜์œผ๋กœํ•œ ์˜จ๋ผ์ธ ์ฝ”๋“œ ๋ฆฌ๋ทฐ ๋ฐฉ๋ฒ•

๊นƒํ—ˆ๋ธŒ ์ปค๋ฐ‹ ์ปจ๋ฒค์…˜


AngularJS Git Commit Message Conventions

๐Ÿš—์ž๋™์ฐจ ๊ฒฝ์ฃผ ๊ฒŒ์ž„ ๋ฏธ์…˜


๊ธฐ๋Šฅ ์š”๊ตฌ์‚ฌํ•ญ

  • ๊ฐ ์ž๋™์ฐจ์— ์ด๋ฆ„์„ ๋ถ€์—ฌํ•  ์ˆ˜ ์žˆ๋‹ค.ย ์ž๋™์ฐจ ์ด๋ฆ„์€ 5์ž๋ฅผ ์ดˆ๊ณผํ•  ์ˆ˜ ์—†๋‹ค.
  • ์ „์ง„ํ•˜๋Š” ์ž๋™์ฐจ๋ฅผ ์ถœ๋ ฅํ•  ๋•Œ ์ž๋™์ฐจ ์ด๋ฆ„์„ ๊ฐ™์ด ์ถœ๋ ฅํ•œ๋‹ค.
  • ์ž๋™์ฐจ ์ด๋ฆ„์€ ์‰ผํ‘œ(,)๋ฅผ ๊ธฐ์ค€์œผ๋กœ ๊ตฌ๋ถ„ํ•œ๋‹ค.
  • ์ „์ง„ํ•˜๋Š” ์กฐ๊ฑด์€ 0์—์„œ 9 ์‚ฌ์ด์—์„œ random ๊ฐ’์„ ๊ตฌํ•œ ํ›„ random ๊ฐ’์ด 4์ด์ƒ์ผ ๊ฒฝ์šฐ์ด๋‹ค.
  • ์ž๋™์ฐจ ๊ฒฝ์ฃผ ๊ฒŒ์ž„์„ ์™„๋ฃŒํ•œ ํ›„ ๋ˆ„๊ฐ€ ์šฐ์Šนํ–ˆ๋Š”์ง€๋ฅผ ์•Œ๋ ค์ค€๋‹ค. ์šฐ์Šน์ž๋Š” ํ•œ๋ช… ์ด์ƒ์ผ ์ˆ˜ ์žˆ๋‹ค.

์‹คํ–‰ ๊ฒฐ๊ณผ

  • ์œ„ ์š”๊ตฌ์‚ฌํ•ญ์— ๋”ฐ๋ผ 3๋Œ€์˜ ์ž๋™์ฐจ๊ฐ€ 5๋ฒˆ ์›€์ง์˜€์„ ๊ฒฝ์šฐ ํ”„๋กœ๊ทธ๋žจ์„ ์‹คํ–‰ํ•œ ๊ฒฐ๊ณผ๋Š” ๋‹ค์Œ๊ณผ ๊ฐ™๋‹ค.
๊ฒฝ์ฃผํ•  ์ž๋™์ฐจ ์ด๋ฆ„์„ ์ž…๋ ฅํ•˜์„ธ์š”(์ด๋ฆ„์€ ์‰ผํ‘œ(,)๋ฅผ ๊ธฐ์ค€์œผ๋กœ ๊ตฌ๋ถ„).
pobi,crong,honux
์‹œ๋„ํ•  ํšŒ์ˆ˜๋Š” ๋ช‡ํšŒ์ธ๊ฐ€์š”?
5

์‹คํ–‰ ๊ฒฐ๊ณผ
pobi : -
crong : -
honux : -

pobi : --
crong : -
honux : --

pobi : ---
crong : --
honux : ---

pobi : ----
crong : ---
honux : ----

pobi : -----
crong : ----
honux : -----

pobi : -----
crong : ----
honux : -----

pobi, honux๊ฐ€ ์ตœ์ข… ์šฐ์Šนํ–ˆ์Šต๋‹ˆ๋‹ค.

ํžŒํŠธ

  • ์ž๋™์ฐจ๋Š” ์ž๋™์ฐจ ์ด๋ฆ„๊ณผ ์œ„์น˜ ์ •๋ณด๋ฅผ ๊ฐ€์ง€๋Š” Car ๊ฐ์ฒด๋ฅผ ์ถ”๊ฐ€ํ•ด ๊ตฌํ˜„ํ•œ๋‹ค.

ํ”„๋กœ๊ทธ๋ž˜๋ฐ ์š”๊ตฌ์‚ฌํ•ญ

  • ์ž๋ฐ” ์ฝ”๋“œ ์ปจ๋ฒค์…˜์„ ์ง€ํ‚ค๋ฉด์„œ ํ”„๋กœ๊ทธ๋ž˜๋ฐํ•œ๋‹ค.
    • ๊ธฐ๋ณธ์ ์œผ๋กœย Google Java Style Guide์„ ์›์น™์œผ๋กœ ํ•œ๋‹ค.
    • ๋‹จ, ๋“ค์—ฌ์“ฐ๊ธฐ๋Š” '2 spaces'๊ฐ€ ์•„๋‹Œ '4 spaces'๋กœ ํ•œ๋‹ค.
  • indent(์ธ๋ดํŠธ, ๋“ค์—ฌ์“ฐ๊ธฐ) depth๋ฅผ 3์ด ๋„˜์ง€ ์•Š๋„๋ก ๊ตฌํ˜„ํ•œ๋‹ค. 2๊นŒ์ง€๋งŒ ํ—ˆ์šฉํ•œ๋‹ค.
    • ์˜ˆ๋ฅผ ๋“ค์–ด while๋ฌธ ์•ˆ์— if๋ฌธ์ด ์žˆ์œผ๋ฉด ๋“ค์—ฌ์“ฐ๊ธฐ๋Š” 2์ด๋‹ค.
    • ํžŒํŠธ: indent(์ธ๋ดํŠธ, ๋“ค์—ฌ์“ฐ๊ธฐ) depth๋ฅผ ์ค„์ด๋Š” ์ข‹์€ ๋ฐฉ๋ฒ•์€ ํ•จ์ˆ˜(๋˜๋Š” ๋ฉ”์†Œ๋“œ)๋ฅผ ๋ถ„๋ฆฌํ•˜๋ฉด ๋œ๋‹ค.
  • else ์˜ˆ์•ฝ์–ด๋ฅผ ์“ฐ์ง€ ์•Š๋Š”๋‹ค.
    • ํžŒํŠธ: if ์กฐ๊ฑด์ ˆ์—์„œ ๊ฐ’์„ returnํ•˜๋Š” ๋ฐฉ์‹์œผ๋กœ ๊ตฌํ˜„ํ•˜๋ฉด else๋ฅผ ์‚ฌ์šฉํ•˜์ง€ ์•Š์•„๋„ ๋œ๋‹ค.
    • else๋ฅผ ์“ฐ์ง€ ๋ง๋ผ๊ณ  ํ•˜๋‹ˆ switch/case๋กœ ๊ตฌํ˜„ํ•˜๋Š” ๊ฒฝ์šฐ๊ฐ€ ์žˆ๋Š”๋ฐ switch/case๋„ ํ—ˆ์šฉํ•˜์ง€ ์•Š๋Š”๋‹ค.
  • 3ํ•ญ ์—ฐ์‚ฐ์ž๋ฅผ ์“ฐ์ง€ ์•Š๋Š”๋‹ค.
  • ํ•จ์ˆ˜(๋˜๋Š” ๋ฉ”์†Œ๋“œ)๊ฐ€ ํ•œ ๊ฐ€์ง€ ์ผ๋งŒ ํ•˜๋„๋ก ์ตœ๋Œ€ํ•œ ์ž‘๊ฒŒ ๋งŒ๋“ค์–ด๋ผ.
  • ๋ชจ๋“  ๊ธฐ๋Šฅ์„ TDD๋กœ ๊ตฌํ˜„ํ•ด ๋‹จ์œ„ ํ…Œ์ŠคํŠธ๊ฐ€ ์กด์žฌํ•ด์•ผ ํ•œ๋‹ค.ย ๋‹จ, UI(System.out, System.in) ๋กœ์ง์€ ์ œ์™ธ (TDD๋ฅผ ์ฒ˜์Œ ์ ‘ํ•˜๊ฑฐ๋‚˜ ๋ชจ๋ฅด์‹ ๋‹ค๋ฉด, ๊ณต๋ถ€ํ›„์— ๊ณต์œ ํ•ด ๋ณด๋Š” ๊ธฐํšŒ๋ฅผ ๊ฐ–๋Š”๊ฑด ์–ด๋–จ๊นŒ์š” ?)
    • ํ•ต์‹ฌ ๋กœ์ง์„ ๊ตฌํ˜„ํ•˜๋Š” ์ฝ”๋“œ์™€ UI๋ฅผ ๋‹ด๋‹นํ•˜๋Š” ๋กœ์ง์„ ๊ตฌ๋ถ„ํ•œ๋‹ค.
    • UI ๋กœ์ง์„ InputView, ResultView์™€ ๊ฐ™์€ ํด๋ž˜์Šค๋ฅผ ์ถ”๊ฐ€ํ•ด ๋ถ„๋ฆฌํ•œ๋‹ค.
  • ๋ชจ๋“  ์›์‹œ ๊ฐ’๊ณผ ๋ฌธ์ž์—ด์„ ํฌ์žฅํ•œ๋‹ค.
  • ์ผ๊ธ‰ ์ปฌ๋ ‰์…˜์„ ์“ด๋‹ค.
  • (์›์‹œ ๊ฐ’ ๋ฌธ์ž์—ด ํฌ์žฅ, ์ผ๊ธ‰ ์ปฌ๋ ‰์…˜ ๋“ฑ๋„ ์ •๋ฆฌํ•˜์—ฌ ๊ฐ™์ด ๊ณต๋ถ€ํ•ด๋ด์š” !)

๊ธฐ๋Šฅ ๋ชฉ๋ก ๋ฐ commit ๋กœ๊ทธ ์š”๊ตฌ์‚ฌํ•ญ

  • ๊ธฐ๋Šฅ์„ ๊ตฌํ˜„ํ•˜๊ธฐ ์ „์— README.md ํŒŒ์ผ์— ๊ตฌํ˜„ํ•  ๊ธฐ๋Šฅ ๋ชฉ๋ก์„ ์ •๋ฆฌํ•ด ์ถ”๊ฐ€ํ•œ๋‹ค.
  • git์˜ commit ๋‹จ์œ„๋Š” ์•ž ๋‹จ๊ณ„์—์„œ README.md ํŒŒ์ผ์— ์ •๋ฆฌํ•œ ๊ธฐ๋Šฅ ๋ชฉ๋ก ๋‹จ์œ„๋กœ ์ถ”๊ฐ€ํ•œ๋‹ค.

AngularJS Commit Message Conventions ์ค‘

  • commit message ์ข…๋ฅ˜๋ฅผ ๋‹ค์Œ๊ณผ ๊ฐ™์ด ๊ตฌ๋ถ„
  • ์œ„ ๋ถ๋งˆํฌ์— ์ฒจ๋ถ€ํ•˜์˜€์œผ๋‹ˆ ์ฐธ๊ณ ํ•˜์‹œ๊ธธ ๋ฐ”๋ž๋‹ˆ๋‹ค.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors