From e233eb2f2da96320bfb575cd16142404df07a9f4 Mon Sep 17 00:00:00 2001 From: YONGBEOM GWON Date: Wed, 29 Jul 2026 17:05:10 +0900 Subject: [PATCH] =?UTF-8?q?docs(community):=20=EA=B8=B0=EC=97=AC=20?= =?UTF-8?q?=EC=A7=84=EC=9E=85=EB=A1=9C=20=EC=B6=94=EA=B0=80=20=E2=80=94=20?= =?UTF-8?q?README=20=ED=95=A8=EA=BB=98=20=EB=A7=8C=EB=93=A4=EA=B8=B0=20?= =?UTF-8?q?=EC=A0=88,=20good=20first=20issue=20=EC=95=88=EB=82=B4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit README 에 CONTRIBUTING 링크조차 없어서, 기여하고 싶은 사람이 무엇부터 손대야 할지 알 방법이 없었다. - README: '함께 만들기' 절 신설. 개발자가 아니어도 할 수 있는 일(코퍼스 페어, 픽토그램 낱말)을 먼저 놓고, good first issue 라벨 검색 링크를 건다. 쉬운 정보는 코드만으로 좋아지지 않는다 — 어떤 문서가 왜 어려운지 아는 사람의 손이 필요하다. - CONTRIBUTING: 로컬 개발 환경을 로컬 모델 기준으로 갱신(#1·#2 반영). '어디서 시작할까' 절 추가. 관련 이슈: #8 #9 #10 #11 --- CONTRIBUTING.md | 15 +++++++++++++-- README.md | 15 +++++++++++++++ 2 files changed, 28 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6fafd59..117438a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,12 +10,23 @@ welcome too — feel free to file issues/PRs in English.) git clone https://github.com/needsbuilder/ttobak.git cd ttobak python3 -m venv venv && source venv/bin/activate # Python 3.11+ -python -m pip install -e ".[dev]" +python -m pip install -e ".[dev,ollama]" python -m pytest -q # 전체 테스트 python -m tooling.check_licenses --root . # 라이선스·보안 감사 게이트 (= ttobak audit) -ttobak web --provider fake # 웹 데모 (API 키 불필요) + +ollama serve & ollama pull qwen2.5:7b # 로컬 모델 (Apache-2.0, 약 4.7GB) +ttobak web # 웹 데모 — 기본이 로컬 모델입니다 ``` +모델을 받기 전에 화면만 먼저 보려면 `ttobak web --provider fake` 를 쓰세요. +고정 응답을 돌려주는 스텁이라 실제 변환이 아니고, 화면에도 그렇게 표시됩니다. + +## 어디서 시작할까 + +[`good first issue`](https://github.com/needsbuilder/ttobak/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) +라벨이 붙은 이슈에 범위와 주의점을 적어 뒀습니다. 코드가 아니어도 됩니다 — +코퍼스 페어와 픽토그램 낱말은 현장을 아는 분의 손이 더 필요한 일입니다. + ## 개발 규율 — TDD 이 저장소는 **실패 테스트 먼저** 규칙으로 개발합니다: diff --git a/README.md b/README.md index e405fea..f3f7f28 100644 --- a/README.md +++ b/README.md @@ -95,6 +95,21 @@ render_html() 원문/쉬운본 나란히 HTML + 면책 + 배지 - 코퍼스는 현재 전부 합성 문서이며 사람 최종 검수가 남아 있습니다. 실문서(KOGL-1) 보강과 100~300쌍 확장은 로드맵입니다. +## 함께 만들기 + +쉬운 정보는 코드만으로 좋아지지 않습니다. 어떤 문서가 왜 어려운지 아는 사람의 +손이 필요합니다. + +**개발자가 아니어도 할 수 있는 것** +- [코퍼스 페어 추가](https://github.com/needsbuilder/ttobak/issues/11) — 지금 11쌍이고 전부 제가 지어낸 예시입니다. 실제 공공문서 기반 페어가 필요합니다 +- [픽토그램 낱말 추가](https://github.com/needsbuilder/ttobak/issues/9) — 글을 읽기 어려운 사람은 그림을 먼저 봅니다. 지금 33개뿐입니다 + +**코드로 시작하기 좋은 것** +- [`good first issue`](https://github.com/needsbuilder/ttobak/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) 라벨을 보세요. 범위와 주의점을 이슈 안에 적어 뒀습니다 + +개발 규율(TDD)·커밋 형식·라이선스 경계는 [`CONTRIBUTING.md`](CONTRIBUTING.md)에 +있습니다. 한국어·영어 모두 환영합니다. + ## 라이선스 — 세 갈래 분리 | 대상 | 라이선스 | 위치 |