๊ณต์ง์ฌํญ
- ๋ฏธ์ ๋ด์ฉ์ ์ธ๋ถ์ ์ ์ถํ์ง ๋ง์์ฃผ์ธ์.
- ํ์ด๋ผ๋ฆฌ ๊ฐ์ ๋ฏธ์ ์ ๊ตฌํํด์ฃผ์ธ์. (์ ๋๋ก ๊ตฌ๊ธ๋ง๋ ์๋ผ์)
- ์ฝ๋๋ฆฌ๋ทฐ ์ ์ ๋ณธ์ธ ํ๊บผ ๊ตฌํํ๊ธฐ ์ ๊น์ง ๋ค๋ฅธ์ฌ๋ 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์ ๊ฐ์ ํด๋์ค๋ฅผ ์ถ๊ฐํด ๋ถ๋ฆฌํ๋ค.
- ๋ชจ๋ ์์ ๊ฐ๊ณผ ๋ฌธ์์ด์ ํฌ์ฅํ๋ค.
- ์ผ๊ธ ์ปฌ๋ ์ ์ ์ด๋ค.
- (์์ ๊ฐ ๋ฌธ์์ด ํฌ์ฅ, ์ผ๊ธ ์ปฌ๋ ์ ๋ฑ๋ ์ ๋ฆฌํ์ฌ ๊ฐ์ด ๊ณต๋ถํด๋ด์ !)
- ๊ธฐ๋ฅ์ ๊ตฌํํ๊ธฐ ์ ์ README.md ํ์ผ์ ๊ตฌํํ ๊ธฐ๋ฅ ๋ชฉ๋ก์ ์ ๋ฆฌํด ์ถ๊ฐํ๋ค.
- git์ commit ๋จ์๋ ์ ๋จ๊ณ์์ README.md ํ์ผ์ ์ ๋ฆฌํ ๊ธฐ๋ฅ ๋ชฉ๋ก ๋จ์๋ก ์ถ๊ฐํ๋ค.
- ์ฐธ๊ณ ๋ฌธ์:ย AngularJS Commit Message Conventions
- commit message ์ข ๋ฅ๋ฅผ ๋ค์๊ณผ ๊ฐ์ด ๊ตฌ๋ถ
- ์ ๋ถ๋งํฌ์ ์ฒจ๋ถํ์์ผ๋ ์ฐธ๊ณ ํ์๊ธธ ๋ฐ๋๋๋ค.