"๋งํฌ๋ค์ด"์ด๋ ๋ฌด์์ ๋๊น?
์ฌ๋ฌ๋ถ๊ณผ ์ ๋ ํ๋ก๊ทธ๋๋จธ์ด๋ฏ๋ก ์ฆ์ Google๋ก ์ด๋ํ์ฌ ๋ค์๊ณผ ๊ฐ์ ์ฒซ ๋ฒ์งธ Wiki ๋งํฌ๋ฅผ ์ฝ๋ ๋ค. Markdown์ ๊ฐ์ฅ ์ฝ๊ธฐ ์ฝ๊ณ ํธ์งํ๊ธฐ ์ฌ์ด ํ ์คํธ๋ฅผ ์์ฑํ๋ค๋ ๋ชฉํ๋ก ๋ง๋ค์ด์ง ๊ฒฝ๋ ๋งํฌ์ ์ธ์ด์ด์ง๋ง ๋ค์๊ณผ ๊ฐ์ ์ฉ๋์ ์ ํฉํฉ๋๋ค. ๊ณ ๊ธ ์ถํ๋ฌผ(HTML, ์์ ์๋ ํ ์คํธ ๋ฐ ๊ธฐํ)์ ์ํ ์ธ์ด๋ก ๋ณํ. ์ฌ๊ธฐ์๋ ์์งํ ์ถ๊ฐํ ๋ด์ฉ์ด ๋ณ๋ก ์๊ณ ๊ฑฐ์ ์๋ฒฝํ ์ค๋ช ์ด๋ผ๊ณ ์๊ฐํฉ๋๋ค.์ด "๋งํฌ๋ค์ด"์ด ์ ํ์ํ๊ฐ์?
์์งํ ๋งํด์, ๊ทธ๊ฒ ์์ด๋ ์ค์ ๋ก ๋์์ง ์์ต๋๋ค :D ๊ทธ๋ฌ๋ ์ฐ๋ฆฌ์ ๋ชฉํ๋ฅผ ๊ธฐ์ตํด ๋ด ์๋ค: ์ด๋ฏธ ์ง์์ ์ธ ํตํฉ์ด ์๊ณ Codecov ๋ฆฌ์์ค์ ๋ํ ์ฝ๋ ์ ์ฉ ๋ฒ์ ํต๊ณ๊ฐ ์๋ ์ ๋ฅํ ํ๋ก์ ํธ ํ ํ๋ฆฟ์ ์์ฑํ๋ ๊ฒ์ ๋๋ค. ๋ด๊ฐ ์ด๊ฒ์ ์ธ๊ธํ ์ด์ ๋ ๋ฌด์์ ๋๊น? ๊ฒ๋ค๊ฐ ๋งํฌ๋ค์ด์ ์ฌ์ฉํ๋ฉด ์ด๋ฌํ ๋ฆฌ์์ค์์ ๋ฐ์ดํฐ๋ฅผ ๊ฐ์ ธ์ ๋ฐ์ดํฐ ์์ฒด๋ฅผ ์ ๊ณตํ๊ฑฐ๋ ์ด ์ ๋ณด๋ฅผ ์ป์ด์ผ ํ๋ ๊ณณ์ผ๋ก ๋ฆฌ๋๋ ์ ํ๋ ๋ฐฐ์ง๋ฅผ ์ ๊ณตํ ์ ์์ต๋๋ค. ์ฌ๋ฌ ๊ณณ์ ํฉ์ด์ ธ ์๋ ๊ฒ๋ณด๋ค ํ๋์ "์ ๋ชฉ" ํ์ด์ง์ ๋ชจ๋ ๋ด์ฉ์ ๋ด๋ ๊ฒ์ด ํธ๋ฆฌํ์ง ์๋์?์ด๋์ ์ฌ์ฉ๋๋์?
์์ ์ ํ๋ก์ ํธ๋ฅผ GitHub์ ํ ๋ฒ ์ด์ ์ ๋ก๋ํ ์ฌ๋์ด๋ผ๋ฉด ๋๊ตฌ๋ GitHub๊ฐ ์ง์์ ์ผ๋ก README ํ์ผ์ ์์ฑํ๋๋ก ์ฌ์ฉ์๋ฅผ ์ด๋ํ๊ณ ์ถ์ดํ๋ค๋ ๊ฒ์ ์๊ณ ์์ต๋๋ค. ์ด ํ์ผ์ ํ์ฅ์๋ ๋ฌด์์ ๋๊น? ๋ง์ต๋๋ค,์ด๋ป๊ฒ ์์ ํ๋์?
๋จผ์ , ๋์น์ฑ์ จ๊ฒ ์ง๋ง GitHub์ ์ง์ ์ถ๊ฐํ๋ฉด ์๋ํ ๊ฒ์ ๋๋ค! ํ์ง๋ง ์๋ฅผ ๋ค์ด ํญ์ ํ๋์ ํ๋ก์ ํธ์๋ง ์ถ๊ฐํ ํ์๋ ์์ต๋๋ค. ๋๋ ์๋ฅผ ๋ค์ด ์ฐ๋ฆฌ๊ฐ ๊ทธ๊ฒ์ ๋ง๋๋ ๋ฐฉ๋ฒ์ ๋ํด ๋ ์๊ฐํ๊ณ ์ถ์ต๋๋ค. ๊ทธ๋ฆฌ๊ณ ์ฌ๊ธฐ์ GitHub๋ ๋ ์ด์ ์ฐ๋ฆฌ์๊ฒ ์ ํฉํ์ง ์์ต๋๋ค. ์ผ๋ฐ์ ์ผ๋ก Markdown ํ์ผ์ GitHub์ ํธ์ํ ๋ชฉ์ ์ผ๋ก๋ง ์์ฑํ ์ ์์ต๋๋ค. ๋์งธ, IDEA๋ฅผ ํตํด ์ง์ ๋ง๋ค ์ ์๋๋ฐ, ์ด๊ฒ์ด ๋ฐ๋ก ์ฐ๋ฆฌ๊ฐ ํ ์ผ์ด์ง๋ง ์ง๊ธ ๋น์ฅ์ ์๋๋๋ค. ์ ์์ ํ์ผ ํ๋๋ฅผ ์์ฑํ๋ ค๋ฉด ๊ฐ๋ ฅํ ๊ฐ๋ฐ ํ๊ฒฝ์ด ํ์ํ๊ฐ์? ์ฌ๊ธฐ์๋ ์ฝ๊ณ ์ฝ์ง ์์ Markdown ํ์ผ ํธ์ง๊ธฐ ์นดํ๋ก๊ทธ๋ฅผ ์ฐพ์๋ณด๋ ๊ฒ์ด ์ข์ต๋๋ค . ๋ ์์ ์ ์ํด Haroopad๋ฅผ ์ ํํ๋๋ฐ , ๋งค์ฐ ๊ฐ๋จํ๊ณ , ์ ๊ทผํ๊ธฐ ์ฝ๊ณ , ์์ฑ ์ค์ธ ๋ด์ฉ์ ์ฆ๊ฐ์ ์ผ๋ก ํํํ๊ณ (IDEA๋ ๋ง์ฐฌ๊ฐ์ง์) ๊ตฌ๋ฌธ ํํธ๊ฐ ์์ต๋๋ค. ํธ์ง๊ธฐ ์ฐฝ์ ๋ชจ์ต์ ๋ค์๊ณผ ๊ฐ์ต๋๋ค. ์ฌ๊ธฐ์์ ๋ด ํ๋ก์ ํธ ์ค ํ๋์ ๋ฏธ๋ฆฌ ๋ง๋ค์ด์ง README.md๋ฅผ ์ด์์ต๋๋ค. ์ผ์ชฝ์๋ ์นํธ ์ํธ, ์ค๋ฅธ์ชฝ์๋ ๋์คํ๋ ์ด, ์ค์์๋ ํ ์คํธ๊ฐ ์์ต๋๋ค. ๋ชจ๋ ๊ฒ์ด ๋งค์ฐ ์์์ ์ด๊ณ ๋จ์ํฉ๋๋ค. ๊ณง ์ค๋ช ํ ๋ฐฐ์ง๋ ๋ณผ ์ ์์ต๋๋ค. ์ด๋ฌํ ํ์ผ์ ์์ฑํ๋ ๋ค๋ฅธ ๋ฐฉ๋ฒ์ ์ ํํ๋ ์ฌ๋๋ค์ ๋๋ผ์ง ๋ง์ญ์์ค. ๋ฌ๋ผ์ง๋ ๊ฒ์ ๊ทธ๋ํฝ ์ธํฐํ์ด์ค๋ฟ์ ๋๋ค. ํ ์คํธ, ๊ตฌ๋ฌธ ๋ฐ ํ์๋ ๋ณ๊ฒฝ๋์ง ์์ต๋๋ค. ์ ์์ ์ ๋งค์ฐ ๊ฐ๋จํฉ๋๋ค. ํ๋ก์ ํธ์ ๋ํ ์ ๋ณด(๋ฐฐ์ง ํฌํจ), ํ๋ก์ ํธ ๊ฐ์ ธ์ค๊ธฐ์ ๋ํ ์ ๋ณด, ํ๋ก์ ํธ ๊ตฌํ์ ๋ํ ์ ๋ณด, ์์ฑ์ ์ฐ๋ฝ์ฒ์ ๋ํ ์ ๋ณด๊ฐ ํฌํจ๋๋๋ก README.md๋ฅผ ์์ฑํฉ๋๋ค. ๋ด๊ฐ ์ด๋ฏธ ๋งํ๋ฏ์ด ๋ชจ๋ ๊ฒ์ด ๋งค์ฐ ๊ฐ๋จํ๊ณ ์์์ ์ ๋๋ค. ์ฌ์ ์ ์์ํฉ์๋ค.-
์ ๋ชฉ(ํ๋ก์ ํธ ์ด๋ฆ)์ ์ฐ์.
ํด์ ์ฐ์ฐ์ " # " ์ ์ฌ์ฉํ์ฌ ์ฃผ์ ์ ๋ชฉ๊ณผ ๊ฐ์ฅ ํฐ ์ ๋ชฉ์ ๋ง๋ ๋ค์ ์ ๋ชฉ์ ์์ฑํฉ๋๋ค. ์ฐ๋ฆฌ์ ๊ฒฝ์ฐ:
# ForJavaRushPublication
-
๊ทธ๋ฐ ๋ค์ ์ ๋ชฉ์ ์กฐ๊ธ ๋ ์๊ฒ ์์ฑํ๊ณ "ํ๋ก์ ํธ ์ ๋ณด"๋ผ๊ณ ์์ฑํ๊ฒ ์ต๋๋ค. ๋ ์์ ํค๋ ์์๋ " # "์ด ๋ ๋ง์ด ๋ถ์ต๋๋ค.
## Information
๊ทธ๋ฐ ๋ค์ ํ๋ก์ ํธ์ ๋ํ ์ ๋ณด๋ฅผ ์์ฑํ๊ฒ ์ต๋๋ค.
-
๊ธฐ์ฌ์ ๋ํ ๋งํฌ๋ฅผ ์ฝ์ ํด ๋ณด๊ฒ ์ต๋๋ค. ์ด ์์ ์ ๋งค์ฐ ๊ฐ๋จํ๊ฒ ์ํ๋๋ฉฐ Haroopad๋ฅผ ์ฌ์ฉํ๋ ๊ฒฝ์ฐ ์นํธ ์ํธ๋ฅผ ์ ๋ ฅํ๋ฉด ํ ํ๋ฆฟ์ด ์๋์ผ๋ก ์ฝ์ ๋ฉ๋๋ค. ๊ตฌ๋ฌธ์ " [text](url) "์ ๋๋ค.
-
๋ฐฐ์ง๋ฅผ ์ฝ์ ํด ๋ณด๊ฒ ์ต๋๋ค. ์ฌ๊ธฐ์ ์ข ๋ ์์ธํ ์ดํด๋ณด๊ฒ ์ต๋๋ค.
๋จผ์ , ์๋ฆ๋ค์์ ์ํด ํ ์ด๋ธ โโํํ๋ก ๋ฐฐ์ดํด ๋ณด๊ฒ ์ต๋๋ค. 2๊ฐ์ ์ด๊ณผ 2๊ฐ์ ์ด์ด ์์ต๋๋ค. ๊ตฌ๋ฌธ์ ๋ค์๊ณผ ๊ฐ์ต๋๋ค.
๊ฒฐ๊ณผ๋ ๋ค์๊ณผ ๊ฐ์ต๋๋ค.
๋ค์์ผ๋ก ๋ฐฐ์ง์ ํ์ดํผ๋งํฌ๋ฅผ ์ฝ์ ํ๊ฒ ์ต๋๋ค. ๊ทธ๋ฐ๋ฐ ๋ฐฐ์ง๋ ์ด๋์ ์ป์ ์ ์๋์? ์ด์ ๊ธฐ์ฌ์์ Codecov๋ฅผ ์ด๋์ ์ป์ ์ ์๋์ง ๋ณด์ฌ์คฌ์ง๋ง ์ด๋ค ๊ฒ์ ์ป์ ์ ์๋์ง๋ ์ธ๊ธํ์ง ์์์ต๋๋ค. Markdown ํ์ผ์ด ์์ผ๋ฏ๋ก Markdown Badge๋ ํ์ํฉ๋๋ค.
๋ณต์ฌํ์ฌ Markdown์ ์ด์ ๋ถ์ฌ๋ฃ๊ธฐ๋ง ํ๋ฉด ๋ฉ๋๋ค. ๊ทธ๋ฌ๋ Codecov๋ JaCoCo ๋ธ๋์น์๋ ๋ํ๋์ง๋ง ๋ง์คํฐ์๋ ๋ํ๋์ง ์์ผ๋ฏ๋ก ์๋์ผ๋ก ์์ ํด์ผ ํ๋ค๋ ์ ์ ์์ง ๋ง์ญ์์ค. Travis CI Badge๋ ํ๋ก์ ํธ ์ด๋ฆ ๋ฐ๋ก ๋ง์ํธ์ ํ์๋๋ฉฐ, ๋น๋ ๋ก๊ทธ๋ ๋ค์๊ณผ ๊ฐ์ต๋๋ค.
๋ฐฐ์ง๋ฅผ ์ ํํ๋ฉด ์ค์ ์ฐฝ์ด ๋ํ๋ฉ๋๋ค.
์ฐ๋ฆฌ๋ ํ์คํ Markdown๊ณผ ํ์ํ ๋ถ๊ธฐ๋ฅผ ์ ํํฉ๋๋ค. ๋ ๊ฐ์ ๋ธ๋์น์ ๋ํด README.md๋ฅผ ๋ง๋ค ์์ ์ธ๋ฐ ์์ง ๋ง์คํฐ ๋ธ๋์น์ Codecov๋ฅผ ๊ตฌํํ์ง ์์๊ธฐ ๋๋ฌธ์ ์ฝ๊ฐ ๋ค๋ฅผ ๊ฒ์ ๋๋ค.
-
์ด ํ๋ก์ ํธ๋ฅผ ๊ฐ์ ธ์ค๊ฑฐ๋ ๋ณต์ ํ๋ ๋ฐฉ๋ฒ์ ๋ํ ์ ๋ณด๋ฅผ ์์ฑํด ๋ณด๊ฒ ์ต๋๋ค. ์ด ์์ ์ ์ํํ๋ ๋ฐฉ๋ฒ์ ์ค๋ช ํ์ง๋ ์์ง๋ง README.md์์ ์ฝ์ ์ ์์ต๋๋ค. ์ฐ๋ฆฌ๋ ํ๋ก์ ํธ์์ ์ฌ์ฉํ ๊ธฐ์ ์ ๋ํด ๊ธ์ ์ฐ๊ณ ๊ทธ์ ๋ํ ๋งํฌ๋ฅผ ๋ฐฐ์นํ ๊ฒ์ ๋๋ค. ๊ทธ๋๋ ์ด๊ฒ์ ๊ต์ก ํ๋ก์ ํธ์ ๋๋ค. ์, ์ฐ๋ฝ์ฒ๋ฅผ ์ ์ด ๋๊ฒ ์ต๋๋ค.
-
๋งํฌ๋ค์ด์ด ์ค๋น๋์์ต๋๋ค. ์ฐ๋ฆฌ๊ฐ ํด์ผ ํ ์ผ์ ํ๋ก์ ํธ์ ์ถ๊ฐํ๋ ๊ฒ๋ฟ์ ๋๋ค. ๊ทธ๋ฌ๋ฉด ์๋ฃ๋ฉ๋๋ค. ๊ทธ๋ฌ๋ ํ๊บผ๋ฒ์๋ ์๋๋๋ค! IDEA๋ฅผ ์ด๊ณ ํ๋ฌ๊ทธ์ธ์์ Markdown ์ง์์ด ์๋์ง ํ์ธํฉ๋๋ค.
์ ๋ Ultimate IDEA๋ฅผ ๊ฐ์ง๊ณ ์์ผ๋ฏ๋ก ๋ชจ๋ ๊ฒ์ ๊ฐ์ถ๊ณ ์์ต๋๋ค. ํ๋ฌ๊ทธ์ธ์ด ๊ธฐ๋ณธ์ ์ผ๋ก ์ค์น๋์ง ์์ ์๋ ์์ง๋ง, ํ์ฅ์๊ฐ md์ธ ํ์ผ์ ์์ฑํ๋ฉด ๋ค์ด๋ก๋ํ๋ผ๋ ๋ฉ์์ง๊ฐ ํ์๋ฉ๋๋ค. IDEA๋ฅผ ๋ค์ด๋ก๋ํ๊ณ ๋ค์ ์์ํ์ธ์.
-
์ฐ๋ฆฌ๊ฐ ์์ฑํ Markdown์ ๊ฐ์ ธ์จ ํ IDEA๋ฅผ ํตํด ์ด๊ณ ํ์ํ ๊ฒฝ์ฐ ํธ์งํฉ๋๋ค. IDEA๋ฅผ ํตํด ๋ณด๋ฉด ๋ค์๊ณผ ๊ฐ์ต๋๋ค.
์ฐ๋ฆฌ๋ ๋ฐ์ด๋ถ์ ๋๋ค. ๊ทธ๋ฐ ๋ค์ ํ๋ก์ ํธ๋ฅผ ์ด๋ฉด ์ด์ ๋ํ ์ ๋ณด๊ฐ ์ฆ์ ๋ก๋๋๋ ๊ฒ์ ๋ณผ ์ ์์ต๋๋ค . ์ด๊ฒ์ด README.md์ ๋๋ค.
์ด์ ๋ฐฐ์ง๋ฅผ ํด๋ฆญํ๋ฉด ํ๋ก์ ํธ ์ด์ ๋ธ๋ฆฌ๋ก ๋ฐ๋ก ์ด๋ํ์ฌ ๊ฑฐ๊ธฐ์ ๋ฌด์์ด ์๊ณ ์ด๋ป๊ฒ ์๋์ง ํ์ธํ ์ ์์ต๋๋ค.
-
์์ง README.md๊ฐ ์๊ธฐ ๋๋ฌธ์ Codecov Badge๋ฅผ ์์ฐํ๊ธฐ ์ํด JaCoCo ๋ธ๋์น์ ๋ํด์๋ ๋์ผํ ์์ ์ ์ํํ๊ฒ ์ต๋๋ค. ๊ฒฐ๊ณผ์ ์ผ๋ก ์ด์ ๋ ๊ฐ์ ๋ฐฐ์ง๊ฐ ์๊ฒผ์ต๋๋ค.
Codecov๋ ์ฝ๋ ์ ์ฉ ๋ฒ์์ ๋ฐฑ๋ถ์จ์ ํ์ํ๋ฉฐ Codecov ํ์ด์ง๋ก ๋ฆฌ๋๋ ์ ํ์ฌ ์์ธํ ์ฝ๋ ์ ์ฉ ๋ฒ์ ๋ณด๊ณ ์๋ฅผ ํ์ํ ์๋ ์์ต๋๋ค.
- ์ํค๊ฐ ๋งํฌ๋ค์ด์ ๊ดํด ์ฐ๋ฆฌ์๊ฒ ์๋ ค์ฃผ๋ ๊ฒ ;
- ๋งํฌ๋ค์ด ํธ์ง์ ๋๋ ํ ๋ฆฌ ;
- ์ ๊ฐ ์ถ์ฒํ๋ ํ๋ฃจํจ๋ ;
- JetBrains ์น์ฌ์ดํธ ์ Markdown ์ ๋ณด
- ๋์ผํ JetBrains์ Markdown Navigator
- ๋ฐฐ์ง ์ ๊ทธ์ ๊ดํ ๋ชจ๋ ๊ฒ. ์ฌ๊ธฐ์์ ๋ฐฐ์ง ์คํ์ผ์ ์ ํํ๊ณ ์ง์ ๋ง์ถค ์ค์ ํ ์ ์์ต๋๋ค.
- ์คํ ์์ค ํ๋ก์ ํธ๋ฅผ ์ ๊ทธ๋ ์ด๋ํ๋ ๋ฐฉ๋ฒ์ ๋ฌด์์ ๋๊น? ์ด ๊ธฐ์ฌ์์๋ ์ด์ ๋ํ ๋ต๋ณ๋ ์ ๊ณตํฉ๋๋ค .
- ์ด์ ๊ธฐ์ฌ
- ์ง์์ ์ธ ํตํฉ ์ ๋ํ ์ฒซ ๋ฒ์งธ ๊ธฐ์ฌ์์ CI๊ฐ ๋ฌด์์ธ์ง, ๋ฌด์์ ์ํ ๊ฒ์ธ์ง, ์ด๋ป๊ฒ ์ฌ์ฉํ๋์ง ์ดํด๋ณด์์ต๋๋ค .
- ์ฐ๋ฆฌ๋ ์ฝ๋ ์ ์ฉ ๋ฒ์ ์ ๊ดํ ๋ ๋ฒ์งธ ๊ธฐ์ฌ์์ CC๋ฅผ ๊ฐ์ง๊ณ ๋์๊ณ CC๊ฐ ๋ฌด์์ธ์ง, ์ ํ์ํ์ง ์ดํดํ์ต๋๋ค .
- ๊ทธ๋ฆฌ๊ณ ์ด๋ฒ ๊ธ์์๋ Markdown์ด ๋ฌด์์ธ์ง, ์ ํ์ํ์ง, ์ด๋ป๊ฒ ํจ๊ณผ์ ์ผ๋ก ์ฌ์ฉํ๋์ง ์ดํด๋ณด์์ต๋๋ค.
GO TO FULL VERSION