Develop/OSS

์˜คํ”ˆ์†Œ์Šค ์‚ฌ์šฉ / ์ฃผ์š” ์˜คํ”ˆ์†Œ์Šค ํ”„๋กœ์ ํŠธ

hello_u 2023. 3. 17. 15:49

 

Open Source Software

 

์ €์ž‘๊ถŒ์ž๊ฐ€ ์†Œ์Šค์ฝ”๋“œ๋ฅผ ๊ณต๊ฐœํ•˜์—ฌ ๋ˆ„๊ตฌ๋‚˜ ์ž์œ ๋กญ๊ฒŒ
์‚ฌ์šฉ, ์ˆ˜์ •, ์žฌ๋ฐฐํฌ ํ•  ์ˆ˜ ์žˆ๋Š” ์†Œํ”„ํŠธ์›จ์–ด

 

์˜คํ”ˆ์†Œ์Šค ์†Œํ”„ํŠธ์›จ์–ด๊ฐ€ ๋ฐ˜๋“œ์‹œ ๋ฌด๋ฃŒ๋กœ ์ œ๊ณต๋˜๋Š” ์‹คํ–‰ ๊ฐ€๋Šฅํ•œ ์†Œํ”„ํŠธ์›จ์–ด๋ผ๋Š” ์˜๋ฏธ๋Š” ์•„๋‹™๋‹ˆ๋‹ค.
๊ทธ๋Ÿฌ๋‚˜ ๊ทธ ์†Œ์Šค ์ฝ”๋“œ๋Š” ๋ฌด๋ฃŒ๋กœ ์ œ๊ณต๋˜์–ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.

 

 

 

๊ธฐ์—…์ด ์˜คํ”ˆ์†Œ์Šค๋ฅผ ์‚ฌ์šฉํ•˜๋Š” ์ด์œ  

๋น„์šฉ์ ˆ๊ฐ / ์ตœ์‹ ๊ธฐ์ˆ  ํ™•๋ณด / 

 

 

์˜คํ”ˆ์†Œ์Šค ์‚ฌ์šฉ๋Ÿ‰์€ ์ฆ๊ฐ€ / ๋…์  ์†Œํ”„ํŠธ์›จ์–ด๋Š” ๊ฐ์†Œ 

 

 

 

 

์˜คํ”ˆ์†Œ์Šค ์„ ํƒ ๊ธฐ์ค€

 

๊ธฐ๋Šฅ ๋น„๊ต ๋ถ„์„

 

ํ”„๋กœ์ ํŠธ์—์„œ ํ•„์š”ํ•œ ๊ธฐ๋Šฅ ์ถฉ์กฑ
- ๊ธฐ๋ณธ ๊ธฐ๋Šฅ์ด ์ ํ•ฉํ•˜๊ฒŒ ์ œ๊ณต๋˜๋Š”๊ฐ€?
- ํ•„์š”ํ•œ ๊ธฐ๋Šฅ๋งŒ ์ œ๊ณตํ•˜๋Š”๊ฐ€?
- ํŒ€์—์„œ ์‚ฌ์šฉํ•˜๊ธฐ์— ์–ด๋ ต์ง€๋Š” ์•Š์€๊ฐ€? (๋ ˆํผ๋Ÿฐ์Šค?) ( ํŒ€์—์„œ ์‚ฌ์šฉํ•˜๋Š” ์–ธ์–ด ์œ ๋ฆฌ ) 
- ์ˆ˜์ •์ด ํ•„์š”ํ•˜๋‹ค๋ฉด ์ˆ˜์ •์€ ๊ฐ€๋Šฅํ•œ๊ฐ€? (LGPL ๋ผ์ด์„ ์Šค์‚ฌ์šฉ์‹œ ์†Œ์Šค์ฝ”๋“œ ๊ณต๊ฐœ ๋ฌธ์ œ์ )

ํ”„๋กœ์ ํŠธ์™€์˜ ํ˜ธํ™˜์„ฑ ๋ฐ ํ™•์žฅ์„ฑ : ์–ธ์–ด, ์šด์˜์ฒด์ œ ๋“ฑ
์„ฑ๋Šฅ ํ™•์ธ ๋ฐ ํ…Œ์ŠคํŠธ

 

 

 

์ €์žฅ์†Œ ํ™•์ธ

 

๊ฐ€์ด๋“œ ๋ฌธ์„œ : Readme
Star ์ˆ˜
์ฐธ์กฐ ํšŸ์ˆ˜
์˜คํ”ˆ๋œ ์ด์Šˆ ์ˆ˜
์˜คํ”ˆ๋œ PR ์ˆ˜
๋งˆ์ง€๋ง‰ ์ปค๋ฐ‹์ผ์‹œ
๋ฆด๋ฆฌ์ฆˆ ์ฃผ๊ธฐ
์†Œ์Šค ์ฝ”๋“œ ํ’ˆ์งˆ

 

 

Github Star ๊ฐ€ ์ตœ์„ ์ผ๊นŒ?

 

Star ์–ด๋ทฐ์ง•์„ ๊ฐ์ง€ํ•˜๋Š” ์‹ ๋ขฐ ์•Œ๊ณ ๋ฆฌ์ฆ˜์„ ์ ์šฉํ•˜์—ฌ ์ ์ˆ˜ ๊ณ„์‚ฐ

 

๋ผ์ด์„ ์Šค ํ™•์ธ

๊นƒํ—™ ์ €์žฅ์†Œ์˜ README ๋ฌธ์„œ , ๋ณ„๋„์˜ ํ™ˆํŽ˜์ด์ง€ LICENSE ๋ฉ”๋‰ด ํ™•์ธ 

 

 

 

์ฃผ์š” ๊ณต๊ฐœSW ๋ผ์ด์„ ์Šค ๋น„๊ต

 

๋ณด์•ˆ

์˜คํ”ˆ์†Œ์Šค์˜ 11%๊ฐ€ ์•Œ๋ ค์ง„ ์ทจ์•ฝ์ ์„ ๊ฐ€์ง€๊ณ  ์žˆ๋‹ค.

 

์‚ฌ์šฉํ•˜๋ ค๋Š” ์˜คํ”ˆ์†Œ์Šค๋ฅผ CVE ์—์„œ ๊ฒ€์ƒ‰ํ•˜์—ฌ ์•Œ๋ ค์ง„ ๋ณด์•ˆ ์ทจ์•ฝ์ ์ด ์žˆ๋Š”์ง€ ํ™•์ธํ•  ์ˆ˜ ์žˆ๋‹ค.

 

 

 

 

๋‚ด๊ฐ€ ์›ํ•˜๋Š” ๊ธฐ๋Šฅ์ด ์žˆ๋Š” ์ฐพ์„ ๋•Œ ์ž˜ ๋งŒ๋“ค์–ด์ง„ ์•ฑ์—์„œ ์‚ฌ์šฉ์ค‘์ธ ์˜คํ”ˆ์†Œ์Šค ํ™•์ธํ•ด๋ณด๋Š” ๋ฐฉ๋ฒ•๋„ ์žˆ๋‹ค.

 

 

 

 

์˜คํ”ˆ์†Œ์Šค์— ํ•„์š”ํ•œ ํŒŒ์ผ

โ— Open source license
โ— README
โ— Contributing guidelines
โ— Code of conduct

 

 

Choosing a license

์ €์žฅ์†Œ๋ฅผ ๋งŒ๋“ค๋•Œ ์–ด๋–ค ๋ผ์ด์„ผ์Šค๋ฅผ ์ด์šฉํ• ์ง€ ์„ ํƒํ•œ๋‹ค.

 

 

Writing a README

โ— ์ด ํ”„๋กœ์ ํŠธ๋Š” ๋ฌด์Šจ ์ผ์„ ํ•˜๋‚˜์š”?
โ— ์ด ํ”„๋กœ์ ํŠธ๊ฐ€ ์œ ์šฉํ•œ ์ด์œ ๋Š” ๋ฌด์—‡์ธ๊ฐ€์š”?
โ— ์–ด๋–ป๊ฒŒ ์‹œ์ž‘ํ•ด์•ผ ํ•˜๋‚˜์š”?
โ— ํ•„์š”ํ•˜๋‹ค๋ฉด ์–ด๋””์—์„œ ๋” ๋งŽ์€ ๋„์›€์„ ๋ฐ›์„ ์ˆ˜ ์žˆ์„๊นŒ์š”?

 

 

 

Writing your contributing guidelines

โ— ๋ฒ„๊ทธ ๋ณด๊ณ ์„œ๋ฅผ ์ œ์ถœํ•˜๋Š” ๋ฐฉ๋ฒ• (์ด์Šˆ์™€ PR ํ…œํ”Œ๋ฆฟ์„ ์‚ฌ์šฉํ•ด ๋ณด์„ธ์š”)
โ— ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ์„ ์ œ์•ˆํ•˜๋Š” ๋ฐฉ๋ฒ•
โ— ํ™˜๊ฒฝ ์„ค์ • ๋ฐ ํ…Œ์ŠคํŠธ ์‹คํ–‰ ๋ฐฉ๋ฒ•
+ ๊ธฐ์ˆ ์  ์„ธ๋ถ€ ์‚ฌํ•ญ๊ณผ ๋”๋ถˆ์–ด ์—ฌ๋Ÿฌ๋ถ„์ด ์–ด๋–ค ๊ธฐ์—ฌ๋ฅผ ๊ธฐ๋Œ€ํ•˜๋Š”์ง€ ์ „๋‹ฌํ•  ์ˆ˜๋„ ์žˆ์Šต๋‹ˆ๋‹ค.
โ— ์›ํ•˜๋Š” ๊ธฐ์—ฌ ์œ ํ˜•
โ— ํ”„๋กœ์ ํŠธ ๋กœ๋“œ๋งต ๋˜๋Š” ๋น„์ „
โ— ๊ธฐ์—ฌ์ž๊ฐ€ ์—ฌ๋Ÿฌ๋ถ„๊ณผ ์—ฐ๋ฝํ•˜๋Š” ๋ฐ ์‚ฌ์šฉํ•  (ํ˜น์€ ์‚ฌ์šฉํ•˜์ง€ ๋ง์•„์•ผ ํ• ) ๋ฐฉ๋ฒ•

 

 

Establishing a code of conduct

โ— ๊ฑด๊ฐ•ํ•˜๊ณ  ๊ฑด์„ค์ ์ธ ์ปค๋ฎค๋‹ˆํ‹ฐ๋ฅผ ์œ„ํ•œ ํ–‰๋™๊ฐ•๋ น
โ— ์ฐธ์—ฌ์ž๊ฐ€ ์–ด๋–ป๊ฒŒ ํ–‰๋™ํ•˜๊ธฐ๋ฅผ ๊ธฐ๋Œ€ํ•˜๋Š”์ง€ ์ „๋‹ฌํ•˜๋Š” ๊ฒƒ ์™ธ์—, ์ด๋Ÿฌํ•œ ๊ธฐ๋Œ€๊ฐ€ ๋ˆ„๊ตฌ์—๊ฒŒ
์ ์šฉ๋˜๋Š”์ง€, ์–ธ์ œ ์ ์šฉ๋˜๋Š”์ง€, ์œ„๋ฐ˜ํ•  ๊ฒฝ์šฐ ์–ด๋–ป๊ฒŒ ํ•˜๋Š”์ง€ ๋“ฑ ํฌํ•จ