From f6bf7630d88d69ab468996a9910e362109e3a0bb Mon Sep 17 00:00:00 2001 From: meraki6512 Date: Sat, 25 Oct 2025 16:46:42 +0900 Subject: [PATCH 1/2] docs: improve contributing guide --- apps/landing/src/app/docs/LeftMenu.tsx | 1 + .../src/app/docs/contributing/page.mdx | 138 ++++++++++++++++++ apps/landing/src/app/docs/overview/page.mdx | 15 +- 3 files changed, 148 insertions(+), 6 deletions(-) create mode 100644 apps/landing/src/app/docs/contributing/page.mdx diff --git a/apps/landing/src/app/docs/LeftMenu.tsx b/apps/landing/src/app/docs/LeftMenu.tsx index 066f874..8382586 100644 --- a/apps/landing/src/app/docs/LeftMenu.tsx +++ b/apps/landing/src/app/docs/LeftMenu.tsx @@ -8,6 +8,7 @@ export function LeftMenu() { 개요 설치 API + 기여하기 ) } diff --git a/apps/landing/src/app/docs/contributing/page.mdx b/apps/landing/src/app/docs/contributing/page.mdx new file mode 100644 index 0000000..7d16062 --- /dev/null +++ b/apps/landing/src/app/docs/contributing/page.mdx @@ -0,0 +1,138 @@ +export const metadata = { + title: '기여하기', + alternates: { + canonical: '/docs/contributing', + } +} + +# 기여하기 + +Braillify는 모든 오픈소스 기여를 환영합니다. + +## 개발 환경 설정 + +### 사전 요구사항 + +- **Rust** +- **Python** 3.9 이상 +- **Node.js** +- **pnpm** (Node.js 패키지 매니저) +- **uv** (Python 패키지 매니저) +- **Git** + +### 설치 및 빌드 + +#### 1. 저장소 Fork 및 Clone + +```bash +git clone git@github.com:/braillify.git +cd braillify +``` + +#### 2. 원본 저장소 연결 + +```bash +git remote add upstream git@github.com:dev-five-git/braillify.git +git fetch --all +``` + +#### 3. 의존성 설치 + +```bash +pnpm install +``` + +**설치 과정에서 자동으로 실행되는 작업:** +- `uv sync` (Python 의존성 설치) +- `cargo install wasm-pack` (WebAssembly 빌드 도구) +- `pip install maturin` (Python 바인딩 빌드 도구) + +#### 4. 빌드 및 테스트 + +```bash +pnpm build +pnpm test +pnpm lint +``` + +
+ +## 테스트 케이스 추가 + +개발 환경 설정이 완료되면 `braillobe-case-collector` 도구를 사용하여 직접 테스트 케이스를 추가할 수 있습니다. + +**1. 터미널 실행** +- **Windows**: PowerShell(권장) 또는 명령 프롬프트(cmd) 사용 +- **macOS/Linux**: 기본 terminal 사용 + +**2. braillove-case-collector 폴더로 이동** +```bash +cd ./braillove-case-collector +``` + +**3. Converter 실행** +```bash +uv run python ./converter.py +``` + +**4. 2024 개정 한국 점자 규정 문서로부터 원하는 단어 드래그 후 복사** +PDF에서 원하는 단어의 점자를 복사합니다. +```csv +⠎⠕⠜ +``` + +**5. 붙여넣기 후 엔터, 실행하여 나온 결과의 숫자와 점자를 복사** +터미널에 복사한 점자를 붙여넣고 엔터를 눌러 변환을 실행한 후, 출력된 숫자 코드와 점자를 복사합니다. + +**6. rule_항번호.csv에 해당 내용 입력** +적절한 `rule_N.csv` 파일을 열고 다음 형식으로 추가하세요: + +`한글단어,^ + +## 기여 방법 + +### 1. 이슈 생성 + +이슈를 열기 전에, 깃허브의 이슈에서 유사한 이슈가 있는지 먼저 검색해주세요. + +### 2. 브랜치 생성 + +```bash +git checkout -b feature/my-contribution +``` + +### 3. 코드 수정 + +- 코드를 수정하거나 새로운 기능을 추가하세요 +- 테스트 케이스를 추가하세요 +- 문서를 업데이트하세요 + +### 4. 테스트 실행 + +```bash +# 전체 테스트 +cargo test + +# Python 테스트 +cd packages/python && pytest && cd ../.. + +# Node.js 테스트 +cd packages/node && npm test && cd ../.. +``` + +### 5. 커밋 및 푸시 + +```bash +git add . +git commit -m "Add feature" +git push origin feature/my-contribution +``` + +### 5. Pull Request 생성 diff --git a/apps/landing/src/app/docs/overview/page.mdx b/apps/landing/src/app/docs/overview/page.mdx index 2c77661..10e1ea3 100644 --- a/apps/landing/src/app/docs/overview/page.mdx +++ b/apps/landing/src/app/docs/overview/page.mdx @@ -22,16 +22,19 @@ Braillify 는 완전 오픈소스 한글 점역 라이브러리입니다.
Rust 기반으로 네이티브 성능을 구현했고, Node.js, Python 등 가장 대중적인 언어들을 지원합니다. -
-# 테스트 케이스 추가 -
+

-[github issue](https://github.com/dev-five-git/braillify/issues) 에서 테스트 케이스 추가를 건의해 주세요. +# 테스트 케이스 추가
-지속적인 테스트 케이스 추가로 옛한글, 수학, 컴퓨터 점자까지 한글 점자 완전 정복을 위하여 함께 노력합시다. +[github issue](https://github.com/dev-five-git/braillify/issues) 에서 테스트 케이스 추가를 건의해주세요. +지속적인 테스트 케이스 추가로 옛한글, 수학, 컴퓨터 점자까지 한글 점자 완전 정복을 위하여 함께 노력합시다.

+ # 기여하기
-모든 오픈소스 기여는 환영입니다. \ No newline at end of file + +Braillify는 모든 오픈소스 기여를 환영합니다. + +**테스트 케이스 추가 방법**, **개발 환경 설정**, **코드 기여** 등 더 자세한 내용은 [기여하기 가이드](/docs/contributing)를 참고해주세요. \ No newline at end of file From adf59914468a832e6efad970d8e6df8eba6956d5 Mon Sep 17 00:00:00 2001 From: meraki6512 Date: Sat, 25 Oct 2025 17:10:05 +0900 Subject: [PATCH 2/2] docs: fix contents MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - fork 방법 추가 --- apps/landing/src/app/docs/contributing/page.mdx | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/apps/landing/src/app/docs/contributing/page.mdx b/apps/landing/src/app/docs/contributing/page.mdx index 7d16062..6a3e83c 100644 --- a/apps/landing/src/app/docs/contributing/page.mdx +++ b/apps/landing/src/app/docs/contributing/page.mdx @@ -24,6 +24,11 @@ Braillify는 모든 오픈소스 기여를 환영합니다. #### 1. 저장소 Fork 및 Clone +1. [brailify 레포지토리](https://github.com/dev-five-git/braillify)에 접속하세요. +2. 페이지 우측 상단에 있는 'Fork 버튼'을 클릭합니다. +3. 이어지는 화면에서 필요하다면 설정값을 조정한 후 'Create fork 버튼'을 클릭하세요. +4. 더 자세한 방법은 [깃허브의 리포지토리 포크 문서](https://docs.github.com/ko/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)를 참고하세요. +5. 포크한 자신의 저장소를 로컬로 클론합니다. ```bash git clone git@github.com:/braillify.git cd braillify