Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions apps/landing/src/app/docs/LeftMenu.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ export function LeftMenu() {
<MenuItem to="/docs/overview">개요</MenuItem>
<MenuItem to="/docs/installation">설치</MenuItem>
<MenuItem to="/docs/api">API</MenuItem>
<MenuItem to="/docs/contributing">기여하기</MenuItem>
</VStack>
)
}
143 changes: 143 additions & 0 deletions apps/landing/src/app/docs/contributing/page.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
export const metadata = {
title: '기여하기',
alternates: {
canonical: '/docs/contributing',
}
}

# 기여하기

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

## 개발 환경 설정

### 사전 요구사항

- **Rust**
- **Python** 3.9 이상
- **Node.js**
- **pnpm** (Node.js 패키지 매니저)
- **uv** (Python 패키지 매니저)
- **Git**

### 설치 및 빌드

#### 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 [email protected]:<your-username>/braillify.git
cd braillify
```

#### 2. 원본 저장소 연결

```bash
git remote add upstream [email protected]: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
```

<br/>

## 테스트 케이스 추가

개발 환경 설정이 완료되면 `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` 파일을 열고 다음 형식으로 추가하세요:

`한글단어,^<mr,숫자코드,점자`
```csv
바위,^<mr,24351323,⠎⠕⠜
```

**제안:** [github issue](https://github.com/dev-five-git/braillify/issues)에서 테스트 케이스 추가를 건의해 주세요.

<br/>

## 기여 방법

### 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 생성
15 changes: 9 additions & 6 deletions apps/landing/src/app/docs/overview/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,19 @@ Braillify 는 완전 오픈소스 한글 점역 라이브러리입니다.
<br/>
Rust 기반으로 네이티브 성능을 구현했고, Node.js, Python 등 가장 대중적인 언어들을 지원합니다.

<br/>
# 테스트 케이스 추가
<br/>
<br/><br/>

[github issue](https://github.com/dev-five-git/braillify/issues) 에서 테스트 케이스 추가를 건의해 주세요.
# 테스트 케이스 추가
<br/>

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

지속적인 테스트 케이스 추가로 옛한글, 수학, 컴퓨터 점자까지 한글 점자 완전 정복을 위하여 함께 노력합시다.<br/>
<br/>

# 기여하기
<br/>
모든 오픈소스 기여는 환영입니다.

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

**테스트 케이스 추가 방법**, **개발 환경 설정**, **코드 기여** 등 더 자세한 내용은 [기여하기 가이드](/docs/contributing)를 참고해주세요.
Loading