Contributing - Info-Share/infowater GitHub Wiki

์ด ์ €์žฅ์†Œ์— ๊ธฐ์—ฌํ•  ๋•Œ ๋ณ€๊ฒฝํ•˜๊ธฐ ์ „์—์ด ์ €์žฅ์†Œ์˜ ์†Œ์œ ์ž์™€ ํ•จ๊ป˜ ๋ฌธ์ œ, ์ „์ž ๋ฉ”์ผ ๋˜๋Š” ๊ธฐํƒ€ ๋ฐฉ๋ฒ•์„ ํ†ตํ•ด ๋ณ€๊ฒฝํ•˜๋ ค๋Š” ๋‚ด์šฉ์„ ๋จผ์ € ๋…ผ์˜ํ•˜์‹ญ์‹œ์˜ค.

์šฐ๋ฆฌ๋Š” ํ–‰๋™ ๊ฐ•๋ น์„ ๊ฐ€์ง€๊ณ  ์žˆ์œผ๋ฏ€๋กœ, ํ”„๋กœ์ ํŠธ์™€์˜ ๋ชจ๋“  ์ƒํ˜ธ ์ž‘์šฉ์„ ๋”ฐ๋ผ ์ฃผ์‹œ๊ธฐ ๋ฐ”๋ž๋‹ˆ๋‹ค.

ํ’€ ์š”์ฒญ ํ”„๋กœ์„ธ์Šค

  1. ๋นŒ๋“œ๋ฅผ ์ˆ˜ํ–‰ ํ•  ๋•Œ ๋ ˆ์ด์–ด๊ฐ€ ๋๋‚˜๊ธฐ ์ „์— ๋ชจ๋“  ์„ค์น˜ ๋˜๋Š” ๋นŒ๋“œ ์ข…์†์„ฑ์ด ์ œ๊ฑฐ๋˜์—ˆ๋Š”์ง€ ํ™•์ธํ•˜์‹ญ์‹œ์˜ค.
  2. README.md๋ฅผ ์ธํ„ฐํŽ˜์ด์Šค์˜ ๋ณ€๊ฒฝ ์‚ฌํ•ญ์œผ๋กœ ์—…๋ฐ์ดํŠธํ•˜์‹ญ์‹œ์˜ค. ์—ฌ๊ธฐ์—๋Š” ์ƒˆ๋กœ์šด ํ™˜๊ฒฝ ๋ณ€์ˆ˜, ๋…ธ์ถœ ๋œ ํฌํŠธ, ์œ ์šฉํ•œ ํŒŒ์ผ ์œ„์น˜ ๋ฐ ์ปจํ…Œ์ด๋„ˆ ๋งค๊ฐœ ๋ณ€์ˆ˜๊ฐ€ ํฌํ•จ๋ฉ๋‹ˆ๋‹ค.
  3. ์˜ˆ์ œ ํŒŒ์ผ์˜ ๋ฒ„์ „ ๋ฒˆํ˜ธ์™€ README.md๋ฅผ์ด ๋Œ์–ด ์˜ค๊ธฐ ์š”์ฒญ์ด ๋‚˜ํƒ€๋‚ด๋Š” ์ƒˆ ๋ฒ„์ „์œผ๋กœ ๋Š˜๋ฆฌ์‹ญ์‹œ์˜ค. ์šฐ๋ฆฌ๊ฐ€ ์‚ฌ์šฉํ•˜๋Š” ๋ฒ„์ „ ๊ด€๋ฆฌ ์ฒด๊ณ„๋Š” SemVer ์ž…๋‹ˆ๋‹ค.
  4. ๋‹ค๋ฅธ ๋‘ ๋ช…์˜ ๊ฐœ๋ฐœ์ž๊ฐ€ ์„œ๋ช… ํ•œ ํ›„์— ํ’€ ์š”์ฒญ์„ ๋ณ‘ํ•ฉ ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๊ทธ๋ ‡์ง€ ์•Š์€ ๊ฒฝ์šฐ ๋‘ ๋ฒˆ์งธ ๊ฒ€ํ† ์ž๊ฐ€ ํ•ด๋‹น ํ•ญ๋ชฉ์„ ๋ณ‘ํ•ฉํ•˜๋„๋ก ์š”์ฒญํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

์œค๋ฆฌ ๊ฐ•๋ น

###์šฐ๋ฆฌ์˜ ์„œ์•ฝ ๊ฐœ๋ฐฉ์ ์ด๊ณ  ํ™˜์˜ํ• ๋งŒํ•œ ํ™˜๊ฒฝ์„ ์กฐ์„ฑํ•˜๊ธฐ ์œ„ํ•ด ์šฐ๋ฆฌ๋Š” ๊ธฐ๋ถ€์ž ๋ฐ ์œ ์ง€์ž๋กœ์„œ ๋‚˜์ด, ์‹ ์ฒด ํฌ๊ธฐ, ์žฅ์• , ๋ฏผ์กฑ์„ฑ, ์„ฑ ์ •์ฒด์„ฑ ๋ฐ ํ‘œํ˜„์— ๊ด€๊ณ„์—†์ด ํ”„๋กœ์ ํŠธ ๋ฐ ์ง€์—ญ ์‚ฌํšŒ์— ๋ชจ๋“  ์‚ฌ๋žŒ๋“ค์„ ๋Œ€์ƒ์œผ๋กœ ํญ๋ ฅ์—†๋Š” ๊ฒฝํ—˜์„ ์ œ๊ณตํ•˜๊ฒ ๋‹ค๊ณ  ์„œ์•ฝํ•ฉ๋‹ˆ๋‹ค. ๊ฒฝํ—˜, ๊ตญ์ , ์™ธ๋ชจ, ์ธ์ข…, ์ข…๊ต ๋˜๋Š” ์„ฑ ์ •์ฒด์„ฑ๊ณผ ์˜ค๋ฆฌ์—”ํ…Œ์ด์…˜์˜ ์ˆ˜์ค€.

์šฐ๋ฆฌ์˜ ํ‘œ์ค€

๊ธ์ •์  ์ธ ํ™˜๊ฒฝ์„ ์กฐ์„ฑํ•˜๋Š” ๋ฐ ๊ธฐ์—ฌํ•˜๋Š” ํ–‰๋™์˜ ์˜ˆ๋Š” ๋‹ค์Œ๊ณผ ๊ฐ™์Šต๋‹ˆ๋‹ค.

  • ํ™˜์˜ํ•˜๊ณ  ํฌ๊ด„์  ์ธ ์–ธ์–ด ์‚ฌ์šฉ
  • ๋‹ค์–‘ํ•œ ๊ฒฌํ•ด์™€ ๊ฒฝํ—˜์„ ์กด์ค‘ํ•จ
  • ์ •์ƒ์ ์œผ๋กœ ๊ฑด์„ค์ ์ธ ๋น„ํŒ์„ ๋ฐ›์•„ ๋“ค์ธ๋‹ค.
  • ์ง€์—ญ ์‚ฌํšŒ์— ๊ฐ€์žฅ ์ ํ•ฉํ•œ ๊ฒƒ์— ์ง‘์ค‘ํ•˜๊ธฐ
  • ๋‹ค๋ฅธ ์ปค๋ฎค๋‹ˆํ‹ฐ ํšŒ์›๋“ค์— ๋Œ€ํ•œ ๊ณต๊ฐ์„ ๋‚˜ํƒ€๋ƒ„

์ฐธ๊ฐ€์ž๋“ค์˜ ์šฉ๋‚ฉ ํ•  ์ˆ˜์—†๋Š” ํ–‰๋™์˜ ์˜ˆ๋Š” ๋‹ค์Œ๊ณผ ๊ฐ™์Šต๋‹ˆ๋‹ค.

  • ์„ฑ์ ์ธ ์–ธ์–ด ๋‚˜ ์ด๋ฏธ์ง€์˜ ์‚ฌ์šฉ๊ณผ ํ™˜์˜๋ฐ›์ง€ ๋ชปํ•˜๋Š” ์„ฑ์  ๊ด€์‹ฌ์ด๋‚˜ ์ง„๋ณด
  • ์กฐ๋กฑ, ๋ชจ์š•์  ์ธ ๋งํˆฌ, ๊ฐœ์ธ์  ๋˜๋Š” ์ •์น˜์  ๊ณต๊ฒฉ
  • ๊ณต์  ๋˜๋Š” ์‚ฌ์ ์ธ ๊ดด๋กญํž˜
  • ๋ช…๋ฐฑํ•œ ํ—ˆ๋ฝ์—†์ด ๋‹ค๋ฅธ ์‚ฌ๋žŒ์˜ ๊ฐœ์ธ ์ •๋ณด (์˜ˆ : ์‹ค์ œ ๋˜๋Š” ์ „์ž ์ฃผ์†Œ) ๊ฒŒ์‹œ
  • ์ „๋ฌธ์ ์ธ ํ™˜๊ฒฝ์—์„œ ๋ถ€์ ์ ˆํ•œ ๊ฒƒ์œผ๋กœ ๊ฐ„์ฃผ ๋  ์ˆ˜์žˆ๋Š” ๊ธฐํƒ€ ํ–‰์œ„

์šฐ๋ฆฌ์˜ ์ฑ…์ž„

ํ”„๋กœ์ ํŠธ ๊ด€๋ฆฌ์ž๋Š” ์ˆ˜์šฉ ๊ฐ€๋Šฅํ•œ ํ–‰๋™์˜ ํ‘œ์ค€์„ ๋ช…ํ™•ํžˆ ํ•  ์ฑ…์ž„์ด ์žˆ์œผ๋ฉฐ ์ˆ˜์šฉ ํ•  ์ˆ˜์—†๋Š” ํ–‰๋™์— ๋Œ€ํ•œ ์ ์ ˆํ•˜๊ณ  ๊ณต์ •ํ•œ ์‹œ์ • ์กฐ์น˜๋ฅผ ์ทจํ•  ๊ฒƒ์œผ๋กœ ์˜ˆ์ƒ๋ฉ๋‹ˆ๋‹ค.

ํ”„๋กœ์ ํŠธ ๊ด€๋ฆฌ์ž๋Š”์ด ํ–‰๋™ ๊ฐ•๋ น์— ๋ถ€ํ•ฉํ•˜์ง€ ์•Š๋Š” ์˜๊ฒฌ, ์ปค๋ฐ‹, ์ฝ”๋“œ, ์œ„ํ‚ค ํŽธ์ง‘, ๋ฌธ์ œ ๋ฐ ๊ธฐํƒ€ ๊ธฐ๊ณ ๋ฅผ ์ œ๊ฑฐ, ํŽธ์ง‘ ๋˜๋Š” ๊ฑฐ๋ถ€ํ•˜๊ฑฐ๋‚˜ ๋‹ค๋ฅธ ํ–‰๋™์— ๋Œ€ํ•ด ๊ธฐ๊ณ ์ž๋ฅผ ์ผ์‹œ์ ์œผ๋กœ ๋˜๋Š” ์˜๊ตฌ์ ์œผ๋กœ ๊ธˆ์ง€ ํ•  ์ˆ˜์žˆ๋Š” ๊ถŒ๋ฆฌ์™€ ์˜๋ฌด๊ฐ€ ์žˆ์Šต๋‹ˆ๋‹ค. ๋ถ€์ ์ ˆํ•˜๊ฑฐ๋‚˜, ์œ„ํ˜‘์ ์ด๊ฑฐ๋‚˜, ๊ณต๊ฒฉ์ ์ด๊ฑฐ๋‚˜, ์œ ํ•ดํ•œ ๊ฒƒ์œผ๋กœ ๊ฐ„์ฃผํ•ฉ๋‹ˆ๋‹ค.

๋ฒ”์œ„

์ด ํ–‰๋™ ๊ทœ๋ฒ”์€ ๊ฐœ์ธ์ด ํ”„๋กœ์ ํŠธ ๋‚˜ ์ง€์—ญ ์‚ฌํšŒ๋ฅผ ๋Œ€ํ‘œ ํ•  ๋•Œ ํ”„๋กœ์ ํŠธ ๊ณต๊ฐ„๊ณผ ๊ณต๊ณต ์žฅ์†Œ ๋ชจ๋‘์— ์ ์šฉ๋ฉ๋‹ˆ๋‹ค. ํ”„๋กœ์ ํŠธ ๋˜๋Š” ์ปค๋ฎค๋‹ˆํ‹ฐ๋ฅผ ๋Œ€ํ‘œํ•˜๋Š” ์˜ˆ๋กœ๋Š” ๊ณต์‹ ํ”„๋กœ์ ํŠธ ์ด๋ฉ”์ผ ์ฃผ์†Œ ์‚ฌ์šฉ, ๊ณต์‹ ์†Œ์…œ ๋ฏธ๋””์–ด ๊ณ„์ •์„ ํ†ตํ•œ ๊ฒŒ์‹œ ๋˜๋Š” ์˜จ๋ผ์ธ ๋˜๋Š” ์˜คํ”„๋ผ์ธ ์ด๋ฒคํŠธ์—์„œ ์ง€์ •๋œ ๋Œ€ํ‘œ๋กœ ํ™œ๋™ํ•˜๋Š” ๊ฒƒ ๋“ฑ์ด ์žˆ์Šต๋‹ˆ๋‹ค. ํ”„๋กœ์ ํŠธ ๋Œ€ํ‘œ์ž๋Š” ํ”„๋กœ์ ํŠธ์˜ ํ‘œํ˜„์„ ๋” ์ •์˜ํ•˜๊ณ  ๋ช…ํ™•ํ•˜๊ฒŒ ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

์‹œํ–‰

ํ•™๋Œ€, ๊ดด๋กญํž˜ ๋˜๋Š” ๊ธฐํƒ€ ์šฉ๋‚ฉ ๋  ์ˆ˜์—†๋Š” ํ–‰๋™์˜ ์‚ฌ๋ก€๋Š” [์ด๋ฉ”์ผ ์ฃผ์†Œ ์‚ฝ์ž…] ํ”„๋กœ์ ํŠธ ํŒ€์— ๋ฌธ์˜ํ•˜์—ฌ๋ณด๊ณ  ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๋ชจ๋“  ๋ถˆ๋งŒ ์‚ฌํ•ญ์€ ๊ฒ€ํ† ๋˜๊ณ  ์กฐ์‚ฌ๋˜๋ฉฐ ์ƒํ™ฉ์— ํ•„์š”ํ•˜๊ณ  ์ ์ ˆํ•˜๋‹ค๊ณ  ํŒ๋‹จ๋˜๋Š” ์‘๋‹ต์ด ๋ฐœ์ƒํ•ฉ๋‹ˆ๋‹ค. ํ”„๋กœ์ ํŠธ ํŒ€์€ ์‚ฌ๊ฑด์˜ ๊ธฐ์ž์™€ ๊ด€๋ จํ•˜์—ฌ ๊ธฐ๋ฐ€ ์œ ์ง€ ์˜๋ฌด๊ฐ€ ์žˆ์Šต๋‹ˆ๋‹ค. ํŠน์ • ์ง‘ํ–‰ ์ •์ฑ…์— ๋Œ€ํ•œ ์ž์„ธํ•œ ๋‚ด์šฉ์€ ๋ณ„๋„๋กœ ๊ฒŒ์‹œ ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

์„ ์˜๋กœ ํ–‰๋™ ์ˆ˜์น™์„ ๋”ฐ๋ฅด์ง€ ์•Š๊ฑฐ๋‚˜ ์‹œํ–‰ํ•˜์ง€ ์•Š๋Š” ํ”„๋กœ์ ํŠธ ๊ด€๋ฆฌ์ž๋Š” ํ”„๋กœ์ ํŠธ ๋ฆฌ๋”์‹ญ์˜ ๋‹ค๋ฅธ ๊ตฌ์„ฑ์›์ด ๊ฒฐ์ •ํ•œ๋Œ€๋กœ ์ผ์‹œ์  ๋˜๋Š” ์˜๊ตฌ์  ์ธ ํŒŒ๊ธ‰ ํšจ๊ณผ์— ์ง๋ฉด ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

์†์„ฑ

๋ณธ ํ–‰๋™ ๊ฐ•๋ น์€ ๊ธฐ์—ฌ์ž ๊ทœ์•ฝ ๋ฒ„์ „ 1.4 ( http://contributor-covenant.org/version/1/4) ์—์„œ ๋ฐœ์ทŒ ํ•œ ๊ฒƒ์ž…๋‹ˆ๋‹ค .