Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ko] markdown guideline #1773

Merged
merged 6 commits into from
Aug 15, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
35 changes: 35 additions & 0 deletions docs/ko/markdown-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# MDN ko locale Markdown 번역에 대한 일반 지침

## 존재하는 파일에 대한 변경 (존재하는 파일이 .html 확장자일 경우)

아래 두 가지 경우에 대해 각각 2개의 commit으로 구분해서 PR을 제출해주세요.

1. 확장자 변경
2. 내용 변경

hochan222 marked this conversation as resolved.
Show resolved Hide resolved
다음 [PR](https://github.com/mdn/translated-content/pull/1771)은 모범적인 PR입니다.

### 확장자 변경

이전 html 파일의 Git History 유지를 위해 확장자만 먼저 .html에서 .md로 변경한 후 commit을 해주세요. 확장자 변경 작업이 없을 경우 Git History가 소멸됩니다. 예시는 [확장자 변경 PR](https://github.com/mdn/translated-content/pull/1769/commits/c7937cf2194d218d98394cd7f5f8acebd2e88aa0)를 참고해주세요.

### 내용 변경

html 형식에서 md로 형식으로 변경한 뒤 commit을 해주세요. `존재하는 파일에 대한 변경 (존재하는 파일이 .html 확장자일 경우)`에 대한 PR은 `squash and merge`를 할 수 없기 때문에, **해당 단계의 commit의 개수를 1개를 넘지 않게 해주세요.**
hochan222 marked this conversation as resolved.
Show resolved Hide resolved

### 리뷰

리뷰로 인해 수정사항이 발생할 경우, 예외적으로 **수정 사항에 대해서 commit의 개수를 1개를 추가적으로 허용합니다.**

> 참고
> `git log --follow (파일)` 로 해당 파일의 git history를 볼 수 있습니다.

hochan222 marked this conversation as resolved.
Show resolved Hide resolved
## 그 이외의 경우 (이미 md 파일이 존재하거나, 해당 번역 페이지가 없는 경우)

일반 PR 방식대로 진행합니다.

# MDN ko locale Markdown 번역에 대한 일반 지침 (리뷰어)

1. `존재하는 파일에 대한 변경 (존재하는 파일이 .html 확장자일 경우)`에 대해서는 `squash and merge`가 아닌 `rebase and merge`를 진행해야합니다.
2. 파일에 대한 Git History가 유지되는지 확인해주세요.
3. commit의 개수는 최소가 되어야 합니다.