기여하기

Braillify는 모든 오픈소스 기여를 환영합니다.

사전 요구사항

도구	설명
Rust	코어 빌드 및 테스트
Python	3.9 이상
Node.js	22 이상
pnpm	Node.js 패키지 매니저
uv	Python 패키지 매니저
Git	형상관리

설치 및 빌드

1. 저장소 Fork 및 Clone

단계	설명
1	brailify 레포지토리에 접속하세요.
2	페이지 우측 상단에 있는 'Fork 버튼'을 클릭합니다.
3	이어지는 화면에서 필요하다면 설정값을 조정한 후 'Create fork 버튼'을 클릭하세요.
4	더 자세한 방법은 깃허브의 리포지토리 포크 문서를 참고하세요.
5	포크한 자신의 저장소를 로컬로 클론합니다.

git clone git@github.com:<your-username>/braillify.git
cd braillify

2. 원본 저장소 연결

git remote add upstream git@github.com:dev-five-git/braillify.git
git fetch --all

3. 의존성 설치

pnpm install

설치 과정에서 자동으로 실행되는 작업:

명령	설명
`uv sync`	Python 의존성 설치
`cargo install wasm-pack`	WebAssembly 빌드 도구
`pip install maturin`	Python 바인딩 빌드 도구

4. 빌드 및 테스트

pnpm build
pnpm test
pnpm lint

테스트 케이스 추가

개발 환경 설정이 완료되면 braillobe-case-collector 도구를 사용하여 직접 테스트 케이스를 추가할 수 있습니다.

1. 터미널 실행

OS	사용 터미널
Windows	PowerShell(권장) 또는 명령 프롬프트(cmd) 사용
macOS/Linux	기본 terminal 사용

2. braillove-case-collector 폴더로 이동

cd ./braillove-case-collector

3. Converter 실행

uv run python ./converter.py

4. 2024 개정 한국 점자 규정 문서로부터 원하는 단어 드래그 후 복사

PDF에서 원하는 단어의 점자를 복사합니다.

⠎⠕⠜

5. 붙여넣기 후 엔터, 실행하여 나온 결과의 숫자와 점자를 복사

터미널에 복사한 점자를 붙여넣고 엔터를 눌러 변환을 실행한 후, 출력된 숫자 코드와 점자를 복사합니다.

6. rule_항번호.csv에 해당 내용 입력

적절한 rule_N.csv 파일을 열고 다음 형식으로 추가하세요:

한글단어,^<mr,숫자코드,점자

바위,^<mr,24351323,⠎⠕⠜

제안: github issue에서 테스트 케이스 추가를 건의해 주세요.

기여 방법

1. 이슈 생성

이슈를 열기 전에, 깃허브의 이슈에서 유사한 이슈가 있는지 먼저 검색해주세요.

2. 브랜치 생성

git checkout -b feature/my-contribution

3. 코드 수정

코드를 수정하거나 새로운 기능을 추가하세요

테스트 케이스를 추가하세요

문서를 업데이트하세요

4. 테스트 실행

# 전체 테스트
cargo test

# Python 테스트
cd packages/python && pytest && cd ../..

# Node.js 테스트
cd packages/node && npm test && cd ../..

5. 커밋 및 푸시

git add .
git commit -m "Add feature"
git push origin feature/my-contribution