์ค๋ ์ฃผ์ ์ฌํญ (5/19, ๊ธ์์ผ)
- ์ค๋์ ๋ฐํ ๋ !
- ํ๋ก์ ํธ
README
์์ฑ
๋๋์ด 1์ฃผ์ฐจ๊ฐ ๋๋ฌ๋ค!!
์ค๋ 14์๋ถํฐ ํ๋ก์ ํธ ๋ฐํ ์์์ด๋ผ, 11์๊น์ง ๋ฐํ ์๋ฃ๋ฅผ ์ ์ถํด์ผํ๋ค. ๋๋ ๋ฐํ ์์ ๋ นํ ๋ด๋น์ ๋ถ๊ป์ ์์ ์ดฌ์ํ์ ๊ฑธ ํธ์งํ๋ ์ผ์ ๋งก์๋ค. ๊ฐ๋จํ ์์ ์ด๊ธด ํ์ง๋ง, ์ ์๋ ๋ถํฐ ์ทจ๋ฏธ๋ก ์ด๊ฑฐ์ ๊ฑฐ ๊ฑด๋๋ ค๋ณธ๊ฒ ์ด๋ฐ ๋์ ์ฐ์ผ ๋๋ง๋ค 'ํ๋ค์์ง๋ง ์๊ฐ๋ญ๋น๋ ์๋์๊ตฌ๋~' ํ๋ ์๊ฐ์ด ๋ ๋ค.
์ค๋ ์ผ์ ์ ๋ฉ์ธ์ ๋ฐํ
์ด๊ธฐ ๋๋ฌธ์, ์๋ง ๋ค๋ฅธ ํ์ ๋ฐํ๋ฅผ ๋ณด๊ณ ๋ณด๊ณ ๋๋ ๊ฒ๋ค, ์๋กญ๊ฒ ๋ฐฐ์ด ๊ฒ๋ค ์์ฃผ๋ก TIL์ ์์ฑํ๊ฒ ๋์ง ์์๊น ์ถ๋ค.
3-5๋ช ์ฉ 10๊ฐ์ ๋์ ํ์ด ์๊ณ , 1๊ฐ์ ํ์ ๋ฐํ๊ฐ ๋๋๋ฉด ํ ๊ฒฐ๊ณผ๋ฌผ์ ๋ํ ํํฐ๋์ ํผ๋๋ฐฑ์ ๋ฐ๋ ์์ผ๋ก ์งํ๋๋ค. ๊ฒฐ๊ณผ๋ฌผ๊ณผ ํผ๋๋ฐฑ์ด ์ฐ๋ฆฌ ํ๊ณผ ๊ด๋ จ์ด ์์์ด๋, ์์ผ๋ก ๊ณต๋ถ๋ฅผ ํ๊ฑฐ๋ ํ๋ก์ ํธ๋ฅผ ์งํํ ๋ ์ด๋ ๋ถ๋ถ์ ์ ๊ฒฝ์ ์ฐ๋ฉด ๋ ์ง๋ฅผ ๋ฐฐ์ธ ์ ์์ด์ ๋ง์ ๋์์ด ๋์๋ค.
๋ณ์ ์ด๋ฆ
๊ฐ ์ธ์ด์ ๋ฐ๋ผ์ ์์ฃผ ์ฌ์ฉํ๋ ๋ณ์์ ์๋ช (๋ช ๋ช ) ๊ท์น์ ์งํค๊ณ , ์ฉ๋๋ฅผ ๋ถ๋ช ํ ์์๋ณผ ์ ์๋๋ก ์๋ช ํ๋ ๊ฒ์ด ์ข๋ค.
ex) ํ์ด์ฌ์ ๊ฒฝ์ฐ : ์๋ช ์ปจ๋ฒค์ | PEP8 ํ๊ตญ์ด ๋ฒ์ญ
๋ธ๋์น ์ด๋ฆ
๋ธ๋์น ์ด๋ฆ์ ๊ธฐ๋ฅ ๋จ์๋ก ํด๋๋ฉด ์ข๋ค.
ex)
์ด๋ฆ_(ํ์ฌ ์์ ์ค์ธ ๊ธฐ๋ฅ)
>>choi_team-page
ํธ๋ฌ๋ธ์ํ (์๋ฌ ๋ฑ)์ ๋ํ ์ ๋ฆฌ
์ด๋ค ๋ฌธ์ ๊ฐ ๋ฐ์ํ๋๋ฐ, ๊ทธ ๋ฌธ์ ๋ ์ด๋ฌํ ๋ฐฉ๋ฒ์ผ๋ก ํด๊ฒฐํ๋ค๋ ์ ๋ฆฌ๋ฅผ ํด๋๋ฉด ์ฅ๊ธฐ์ ์ผ๋ก ํฐ ๋์์ด ๋๋ค.
์ญํ ๋ถ๋ฐฐ
- ๊ฐ๊ฐ ํ ์ฒซ ํ๋ก์ ํธ๋ผ ๊ฒฐ๊ณผ๋ฌผ๋ณด๋ค๋ 'ํ์ ๊ฒฝํ'์ด ์ค์ํ๋ค๊ณ ๊ฐ์กฐ๋ฅผ ๋ง์ดํ์ จ๋๋ฐ, ๊ทธ๋์ ๊ทธ๋ฐ์ง ์ญํ ๋ถ๋ฐฐ์ ์ ๊ฒฝ์ ์ด ํ์ด ๋ง์๋ค.
- ์ฐ๋ฆฌ ํ์ ๊ฒฝ์ฐ๋ ์ญํ ๋ถ๋ฐฐ์ ์๊ฐ์ ๋ง์ด ์์ง๋ ๋ชปํด์ ๋ค์ ํ๋ก์ ํธ ์งํ๋ถํฐ๋ ์ ๊ฒฝ์ ์จ๋ณผ๊น ํ๋ค.
๋ฐ๋๋ ์ ๋ณด์ ๋ฐ๋์ง ์๋ ์ ๋ณด
๋ฐ๋์ง ์๋ ์ ๋ณด์ ๊ฒฝ์ฐ๋ DB์ ์ ์ฅํด์ ์ ๋ณด๋ฅผ ๊บผ๋ด์ค๊ธฐ๋ณด๋ค๋, ํ๋ก ํธ์์ ์ฒ๋ฆฌํ๋ ๊ฒฝ์ฐ๊ฐ ๋ง๋ค.
๋์์ธ๊ณผ ์์ด๋์ด
๊ธฐ๋ฐํ ์์ด๋์ด๋ฅผ ๋ด์ ์ ์ฉํ ํ์ด ๋ง์๋ค. ์ ๋๋ฉ์ด์ ํจ๊ณผ๋ฅผ ์ฌ์ฉํ๊ฑฐ๋, ๊ฒ์์ฒ๋ผ ๋ง๋ค๋๋ก ๋์์ธํ ํ๋ค๋ ์์๊ณ , ํ์ด์ง ์ธ์ ์ธ ๋์์ธ์ ์ ๊ฒฝ์ ์ด ํ๋ ๋ง์๋ค. ํ์คํ ์ข์ ์์ด๋์ด๋ ๋ฐํ๊ฐ ๋๋๊ณ ๋ ๊ธฐ์ต์ ๊ฐ๋ ฌํ๊ฒ ๋จ๋ ๊ฒ ๊ฐ๋ค.
์ ์๊ถ ํ์
ํฅํ ํ๋ก์ ํธ ๋์ฉ ๋ฐฉ์ง๋ฅผ ์ํด ํด๋๋ฉด ์ข๋ค!
๋ฐฐํฌ
ํ๋ก์ ํธ๋ฅผ ์งํํ๊ณ ๋ฐฐํฌ๊น์ง ๊ฐ๋ ๊ฒฝ์ฐ๋ ํ์น์๋ค. ๋ฐฐํฌ๋ฅผ ํ๋ ๊ฒฝํ ์์ฒด๋ ๊ทํ๊ธฐ ๋๋ฌธ์, ๊ฒฐ๊ณผ๋ฌผ์ ํํ๊ฐ ์ด๋ป๋ ๋ฐฐํฌ๋ฅผ ํด๋ณธ ๊ฒ๋ง์ผ๋ก ๋๋จํ๋ค๊ณ ํ๋ค (!)
๋์์ธ์ ํ ๋ ์ฌ์ฉ์๋ฅผ ๊ณ ๋ คํ์ ๋ค๋ ๋ถ๋ ๊ณ์ จ๊ณ , ๊ธฐ๋ฅ์ ์ด๋ป๊ฒ ๊ตฌํํ๋ฉด ์ข์์ง ๊น๊ฒ ํ๊ณ ๋๋ ๋ถ๋ ๊ณ์ จ๋ค. ์ด๋ฒ ์ค์ฌ ์ฃผ์ ์ค ํ๋๊ฐ ํ์ ์ด๋ค๋ณด๋, ํ์ ์ ์ ๊ฒฝ์ ๋ง์ด ์ฐ์ ๋ถ๋ค๋ ๊ณ์ จ๋ค. ๋๋ DB์ ์๋ฒ์ ์ฝํด์ ํ์ต์ ๋ง์ด ๋งค๋ฌ๋ ธ๋๋ฐ, ์๋ง ๋๊ฐ์ ๊ณ ๋ฏผ์ ํ ์ฌ๋๋ ์์ง ์์์๊น ์ถ๋ค.
๊ฐ์ ์ฃผ์ ๋ฅผ ๋๊ณ ๋ ๋ด ์์๋ณด๋ค ๋ ๋ค์ํ ์์ ์ผ๋ก ๋ฐ๋ผ๋ณด๋๊ตฌ๋ ์ถ์ด์ ์ธ์๊น์๋ค.
README.md
์์ฑ์ฌ์ฉ ํ ํ๋ฆฟ: README-cheatsheet
์ ํฌ ํ ๊นํ๋ธ ํ์ด์ง ๊ฐ์๋ฉด ํ์ธํด๋ณด์ค ์ ์์ต๋๋ค ๐
โก๏ธ Introduce-my-team-CLOVER
๋งค๋์ ๋์ผ๋ก๋ถํฐ 'README ์์ฑํ๋ฉด ์ข๊ฒ ๋ค~'๋ ๋ง์ด ๋์ค์๋ง์ ๋น๊ณผ ๊ฐ์ ์๋๋ก "์ ๊ฐ ์์ฑํ๊ฒ ์ต๋๋ค!"
๋ผ๊ณ ๋ฐ์ฌ์ ์ผ๋ก ๋งํด๋ฒ๋ ธ๋ค. ใ
ใ
์ด๋ ๊ฒ ๊ธ๋ก ์ ๋ฆฌํ๋๊ฒ ์ ์ด๋ ๊ฒ ๋ฟ๋ฏํ๊ณ ์ฌ๋ฐ๋์ง ใ
ใ
...