Skip to content

Latest commit

ย 

History

History
78 lines (55 loc) ยท 4.8 KB

CONTRIBUTING_ko.md

File metadata and controls

78 lines (55 loc) ยท 4.8 KB

๊ธฐ์—ฌํ•˜๊ธฐ

็ฎ€ไฝ“ไธญๆ–‡ | English | ๆ—ฅๆœฌ่ชž | ํ•œ๊ตญ์–ด | ะ ัƒััะบะธะน | Espaรฑol | Portuguรชs (Brasil)

AnyModelBot์„ ๋” ๋‚˜์€ ์•ฑ์œผ๋กœ ๋งŒ๋“œ๋Š” ๋ฐ ํ•จ๊ป˜ํ•ด ์ฃผ์…”์„œ ๊ฐ์‚ฌํ•ฉ๋‹ˆ๋‹ค. ๋ฒ„๊ทธ ์ œ๋ณด, ์ˆ˜์ •, ๋ฌธ์„œ, ์•„์ด๋””์–ด ๋ชจ๋‘ ํ™˜์˜ํ•ฉ๋‹ˆ๋‹ค.

์งˆ๋ฌธ ๋ฐ ์˜๊ฒฌ

  • ์งˆ๋ฌธ, ์•„์ด๋””์–ด, ์‚ฌ์šฉ ์‚ฌ๋ก€: GitHub Discussions
  • ๋ฒ„๊ทธ ๋ฐ ๊ธฐ๋Šฅ ์š”์ฒญ: ํ…œํ”Œ๋ฆฟ์„ ์‚ฌ์šฉํ•ด GitHub Issues์— ์ œ์ถœ
  • ๋ณด์•ˆ ๋ฌธ์ œ: ๊ณต๊ฐœ ์ด์Šˆ๋ฅผ ์—ด์ง€ ๋ง๊ณ  ๋ณด์•ˆ ์ •์ฑ…์— ๋”ฐ๋ผ ๋น„๊ณต๊ฐœ ์‹ ๊ณ 
  • ๊ทธ ๋ฐ–์˜ ๋ฌธ์˜: support@anymodel.bot

๋ฒ„๊ทธ๋ฅผ ์‹ ๊ณ ํ•  ๋•Œ ๋‹ค์Œ ์ •๋ณด๋ฅผ ํฌํ•จํ•ด ์ฃผ์„ธ์š”.

  • ๋ฒ„์ „(์„ค์ • โ†’ ์•ฑ ์ •๋ณด), ์šด์˜์ฒด์ œ์™€ ์•„ํ‚คํ…์ฒ˜(์˜ˆ: Windows 11 x64, macOS 15 Apple silicon), ์‹คํ–‰ ๋ฐฉ์‹(๋ฐ์Šคํฌํ†ฑ / ๋ช…๋ น์ค„ / Docker)
  • ์žฌํ˜„ ๋‹จ๊ณ„, ๊ธฐ๋Œ€ํ•œ ๊ฒฐ๊ณผ, ์‹ค์ œ ๊ฒฐ๊ณผ
  • ์ง„๋‹จ ์ •๋ณด: ์„ค์ • โ†’ ๋ฌธ์ œ ํ•ด๊ฒฐ โ†’ โ€˜์ง„๋‹จ ์ •๋ณด ๋ณต์‚ฌโ€™(API ํ‚ค์™€ ํ† ํฐ์€ ***๋กœ ๋Œ€์ฒด๋จ). ๋กœ๊ทธ๋Š” ๋ฐ์ดํ„ฐ ํด๋”์˜ logs/app.log์— ์žˆ์Šต๋‹ˆ๋‹ค. ์œ„์น˜๋Š” ๊ฐœ์ธ์ •๋ณด ๋ฌธ์„œ๋ฅผ ํ™•์ธํ•˜์„ธ์š”.
  • ํŠน์ • ๋ชจ๋ธ ๊ด€๋ จ ๋ฌธ์ œ๋ผ๋ฉด ๋ชจ๋ธ ID

๊ฐœ๋ฐœ ํ™˜๊ฒฝ ์„ค์ •

Node.js 22.13 ์ด์ƒ๊ณผ ๋‚ด์žฅ magpie ๊ฒŒ์ดํŠธ์›จ์ด ์ปดํŒŒ์ผ์„ ์œ„ํ•œ Go 1.26.8 ์ด์ƒ์ด ํ•„์š”ํ•ฉ๋‹ˆ๋‹ค.

git clone https://github.com/modelflare-ai/AnyModelBot.git
cd AnyModelBot
npm install
npm run setup          # vendor/magpie ์„œ๋ธŒ๋ชจ๋“ˆ์„ ๊ฐ€์ ธ์™€ build/bin/์— ์ปดํŒŒ์ผ
๋ช…๋ น ๊ธฐ๋Šฅ
npm start ๋ช…๋ น์ค„ ์‹คํ–‰: ๊ฒŒ์ดํŠธ์›จ์ด + ๋ด‡ + http://127.0.0.1:3600/ ์ฝ˜์†”
npm run dev ๊ฐ™์€ ๋ฐฉ์‹์œผ๋กœ ์‹คํ–‰ํ•˜๋ฉฐ ์ฝ”๋“œ ๋ณ€๊ฒฝ ์‹œ ๋‹ค์‹œ ์‹œ์ž‘
npm run electron:dev ๊ฐœ๋ฐœ ๋ชจ๋“œ ๋ฐ์Šคํฌํ†ฑ ์•ฑ
npm run electron:smoke ๋ฐ์Šคํฌํ†ฑ ์Šค๋ชจํฌ ํ…Œ์ŠคํŠธ(ํ™”๋ฉด ์—†๋Š” Linux์—์„œ๋Š” xvfb-run ์‚ฌ์šฉ)
npm run typecheck TypeScript ํƒ€์ž… ๊ฒ€์‚ฌ
npm test ๋‹จ์œ„ ํ…Œ์ŠคํŠธ + ์˜คํ”„๋ผ์ธ ์ข…๋‹จ ๊ฐ„ ํ…Œ์ŠคํŠธ + ๊ฒŒ์ดํŠธ์›จ์ด ํ†ตํ•ฉ ํ…Œ์ŠคํŠธ
npm run test:dsh-bundle Electron์—์„œ ์‹ค์ œ DSH ํ†ตํ•ฉ ํ…Œ์ŠคํŠธ(๋จผ์ € prepare:dsh + bundle:dsh ์‹คํ–‰)
npm run docs:check README ์ž์ฒด ๊ฒ€์‚ฌ

์ €์žฅ์†Œ ๊ตฌ์กฐ, ํŒจํ‚ค์ง•, ์ฑ„๋„ ์„ค์ •์€ ๊ฐœ๋ฐœ ์•ˆ๋‚ด๋ฅผ ํ™•์ธํ•˜์„ธ์š”.

๋ธŒ๋žœ์น˜ ๋ฐ ํ’€ ๋ฆฌํ€˜์ŠคํŠธ

  1. ์ €์žฅ์†Œ๋ฅผ ํฌํฌํ•˜๊ณ  master์—์„œ ๋ธŒ๋žœ์น˜๋ฅผ ๋งŒ๋“œ์„ธ์š”.

  2. ํ‘ธ์‹œ ์ „์— ๋‹ค์Œ์„ ์‹คํ–‰ํ•˜์„ธ์š”.

    npm run typecheck && npm test

    README๋‚˜ docs/๋ฅผ ๋ณ€๊ฒฝํ–ˆ๋‹ค๋ฉด npm run docs:check๋„ ์‹คํ–‰ํ•˜์„ธ์š”.

  3. master๋ฅผ ๋Œ€์ƒ์œผ๋กœ ํ’€ ๋ฆฌํ€˜์ŠคํŠธ๋ฅผ ์—ด๊ณ  ๋ณ€๊ฒฝ ๋‚ด์šฉ, ์ด์œ , ๊ฒ€์ฆ ๋ฐฉ๋ฒ•์„ ์„ค๋ช…ํ•˜์„ธ์š”. ํ™”๋ฉด ๋ณ€๊ฒฝ์—๋Š” ์Šคํฌ๋ฆฐ์ƒท์„ ํฌํ•จํ•ด ์ฃผ์„ธ์š”.

  4. ์ž‘์€ ์ˆ˜์ •์„ ๋„˜์–ด์„œ๋Š” ์ž‘์—…(์ƒˆ ๊ธฐ๋Šฅ, ๊ตฌ์กฐ ๋ณ€๊ฒฝ, ์ƒˆ ์˜์กด์„ฑ)์€ ๋จผ์ € ์ด์Šˆ๋ฅผ ์—ด์–ด ๋ฐฉํ–ฅ์„ ๋…ผ์˜ํ•œ ๋’ค ์ง„ํ–‰ํ•ด ์ฃผ์„ธ์š”.

  5. ํ•˜๋‚˜์˜ PR์—๋Š” ํ•˜๋‚˜์˜ ๋ณ€๊ฒฝ ์ฃผ์ œ๋ฅผ ๋‹ด๊ณ  ๊ธฐ์กด ์ปค๋ฐ‹ ํ˜•์‹(feat(scope): โ€ฆ, fix(scope): โ€ฆ)์„ ๋”ฐ๋ฅด์„ธ์š”.

ํ™”๋ฉด ๋ณ€๊ฒฝ

  • ui/design์˜ ํ† ํฐ๊ณผ ๊ตฌ์„ฑ ์š”์†Œ๋ฅผ ์‚ฌ์šฉํ•˜์„ธ์š”(ui/design/README.md ์ฐธ์กฐ). ์ž„์˜์˜ ์ƒ‰์ƒ์ด๋‚˜ ๊ธ€์ž ํฌ๊ธฐ๋ฅผ ์ถ”๊ฐ€ํ•˜์ง€ ๋งˆ์„ธ์š”.
  • ๋ธŒ๋žœ๋“œ ๊ฐ•์กฐ์ƒ‰์€ ํ˜•๊ด‘ ์—ฐ๋‘์ƒ‰ #d7ff00์ž…๋‹ˆ๋‹ค. ํ™”๋ฉด์— ํŒŒ๋ž€์ƒ‰์„ ์ถ”๊ฐ€ํ•˜์ง€ ๋งˆ์„ธ์š”.
  • ์ฝ˜์†”์€ ๋ณ„๋„ ๋นŒ๋“œ ์—†๋Š” Preact + htm์œผ๋กœ ๊ตฌ์„ฑ๋˜์–ด ์žˆ์Šต๋‹ˆ๋‹ค. ๋ฒˆ๋“ค๋Ÿฌ๋‚˜ ์ปดํŒŒ์ผ์ด ํ•„์š”ํ•œ ํ”„๋ŸฐํŠธ์—”๋“œ ์˜์กด์„ฑ์„ ์ถ”๊ฐ€ํ•˜์ง€ ๋งˆ์„ธ์š”.
  • ๋ผ์ดํŠธ์™€ ๋‹คํฌ ํ…Œ๋งˆ๋ฅผ ๋ชจ๋‘ ํ™•์ธํ•˜์„ธ์š”.
  • ํ™”๋ฉด ๋ฌธ๊ตฌ๋ฅผ ํ•˜๋“œ์ฝ”๋”ฉํ•˜์ง€ ๋งˆ์„ธ์š”. ui/locales/zh-CN/์™€ ui/locales/en/ ์–‘์ชฝ์— ์ถ”๊ฐ€ํ•˜๊ณ  t()๋ฅผ ์‚ฌ์šฉํ•˜์„ธ์š”. ์ œ์ถœ ์ „์— node scripts/i18n-check.mjs๋ฅผ ์‹คํ–‰ํ•˜๊ณ  ๋‘ ์–ธ์–ด๋ฅผ ๋ชจ๋‘ ํ™•์ธํ•˜์„ธ์š”. ์˜์–ด๊ฐ€ ๋Œ€๊ฐœ ๋” ๊น๋‹ˆ๋‹ค.

์ œ3์ž ์ฝ”๋“œ์™€ ์˜์กด์„ฑ

  • ์˜์กด์„ฑ์„ ์ถ”๊ฐ€ํ•˜๊ฑฐ๋‚˜ ์™ธ๋ถ€ ์ฝ”๋“œ๋ฅผ ํฌํŒ…ยท์ˆ˜์ •ํ–ˆ๋‹ค๋ฉด THIRD_PARTY_NOTICES.md์— ์ถœ์ฒ˜, ๋ฒ„์ „, ๋ผ์ด์„ ์Šค๋ฅผ ๊ธฐ๋กํ•˜์„ธ์š”.
  • AGPL, SSPL, FSL์ฒ˜๋Ÿผ MIT ๋ฐฐํฌ์™€ ํ˜ธํ™˜๋˜์ง€ ์•Š๋Š” ๋ผ์ด์„ ์Šค์˜ ๊ตฌ์„ฑ ์š”์†Œ๋ฅผ ์ถ”๊ฐ€ํ•˜์ง€ ๋งˆ์„ธ์š”.

ํ–‰๋™ ๊ฐ•๋ น

์นœ์ ˆํ•˜๊ฒŒ, ์‚ฌ์‹ค์— ๊ทผ๊ฑฐํ•ด ์†Œํ†ตํ•˜์„ธ์š”. ๋ชจ๋“  ์ฐธ์—ฌ์ž๋ฅผ ์กด์ค‘ํ•˜๊ณ  ์‚ฌ๋žŒ ๋Œ€์‹  ์•„์ด๋””์–ด๋ฅผ ๋น„ํŒํ•˜์„ธ์š”. ๊ดด๋กญํž˜, ์ธ์‹ ๊ณต๊ฒฉ, ์ฐจ๋ณ„์  ํ‘œํ˜„์€ ํ—ˆ์šฉํ•˜์ง€ ์•Š์Šต๋‹ˆ๋‹ค. ๊ด€๋ฆฌ์ž๋Š” ์ด ๊ธฐ์ค€์— ๋งž์ง€ ์•Š๋Š” ๋‚ด์šฉ์„ ์‚ญ์ œํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์šฐ๋ ค ์‚ฌํ•ญ์€ support@anymodel.bot์œผ๋กœ ์•Œ๋ ค ์ฃผ์„ธ์š”.

๋ผ์ด์„ ์Šค

์ œ์ถœํ•œ ๊ธฐ์—ฌ๋Š” ์ด ์ €์žฅ์†Œ์˜ MIT ๋ผ์ด์„ ์Šค๋กœ ๋ฐฐํฌ๋ฉ๋‹ˆ๋‹ค.