CONTRIBUTING.md

기여 가이드라인

rfc-kr 프로젝트는 외부 기여자를 환영합니다.

오타, 오역 등의 문제를 발견하시면 자유롭게 PR을 열어주세요. 만약 새로운 문서를 번역하고 싶으시다면 Discussions에 요청 해 주시면 검토 후 기여 레이아웃을 만들어 드립니다.

문서 번역 진행 현황은 Projects에서 확인 하실 수 있습니다.

만약 이 프로젝트에 기여하고 싶으시다면 아래 규약을 숙지 해 주시기 바랍니다.

프로젝트 구조

rfc-kr은 아래와 같은 구조로 이루어져 있습니다.

docs 디렉터리 하위에 각 RFC 문서 디렉터리가 위치하고, 하위에 각 섹션이 존재합니다. 섹션의 계층은 디렉터리 계층으로 구분하고, 본문은 그 섹션 디렉터리 하위의 README.md에 작성합니다.

.
├── CONTRIBUTING.md
├── README.md
├── ...
└── docs
    └── rfc-1
        ├── 1
        │   ├── 1
        │   │   └── README.md
        │   └── README.md
        └── README.md

번역 프로세스

문서의 번역은 다음과 같은 과정을 거칩니다.

1. RFC 문서 번역 요청

외부 기여자 혹은 메인테이너가 새로운 문서의 번역을 요청합니다.

번역 요청은 Discussions 탭을 사용합니다. 문서의 번호를 명시해야 합니다.

2. 번역 레이아웃 생성

메인테이너가 요청을 검토하고, 번역 레이아웃을 생성합니다.

번역 레이아웃은 다음을 포함합니다:

• 문서 번역용 브랜치 (이하 rfc-branch)
• main <- rfc-branch PR
• 문서의 각 섹션에 1:1 대응되는 이슈 생성 (기여자 할당용)

3. 번역 작업 및 병합

문서에 기여하고자 하는 사람(기여자)은 rfc-branch를 기준 브랜치로 새로운 브랜치(fork-branch)를 만듭니다. 이 작업은 기여자의 포크(fork)된 레포지터리에서 진행됩니다.

후술할 규칙대로 번역, 커밋한 후, PR을 생성합니다. PR은 rfc-branch <- fork-branch 방향으로 생성합니다.

PR의 범위에 맞게 이슈들이 할당됩니다. 이슈를 할당함으로써 문서 번역 현황을 확인함과 동시에 중복을 방지 할 수 있습니다.

이후 메인테이너의 리뷰를 받고, rfc-branch에 병합시킵니다.

4. 문서 번역 완료

3번 작업은 문서의 모든 섹션이 완성 될 때까지 반복됩니다.

모든 섹션이 번역되면 main <- rfc-branch PR을 병합합니다.

기타

3번 작업에서 여러 이유로 slow down이 발생 할 수 있습니다. 이 경우에는 메인테이너가 임의로 PR의 범위를 수정하여 병합시킬 수 있습니다.

문서 형식

TBA

PR 작성법

PR의 제목은 다음과 같은 규칙을 따릅니다.

[RFC-{문서 번호}] {세부 사항 요약}

각 문서 섹션의 변경 사항은 하나의 커밋으로 취급합니다. 원활한 리뷰를 위해 커밋을 모아 PR을 올리는 게 아닌, 첫 커밋에 Draft PR을 올리고 이후 변경 사항을 추가로 올려주시기 바랍니다.

커밋 메시지 포맷

RFC 문서와 관련된 모든 커밋의 메시지는 아래와 같은 포맷을 지켜야 합니다.

커밋 메시지 헤더와 본문은 줄바꿈을 통해 분리되어야 합니다.

[RFC-{문서 번호}] {섹션 번호 혹은 Abstract(ToC 시작 전 본문)} - {세부 사항 요약}

세부 사항 (존재한다면)

예시

[RFC-1945] 1 - ToC 포맷 변경

ToC의 포맷을 테이블 형식에서 리스트 형식으로 수정하였습니다.