diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ko/markdown-guide.md | 29 | ||||
| -rw-r--r-- | docs/ko/translation-guide.md | 10 |
2 files changed, 39 insertions, 0 deletions
diff --git a/docs/ko/markdown-guide.md b/docs/ko/markdown-guide.md new file mode 100644 index 0000000000..293e0ba550 --- /dev/null +++ b/docs/ko/markdown-guide.md @@ -0,0 +1,29 @@ +# MDN ko locale Markdown 번역에 대한 일반 지침 + +## .html 확장자에서 .md 확장자로의 파일 변경일 경우 + +아래 두 가지 경우에 총 2개의 commit으로 구분해서 PR을 제출해주세요. + +1. 확장자만 `html`에서 `md`로 바꾸고 commit 해주세요. +2. `html` 형식에서 `md` 형식으로 변경한 뒤 commit을 해주세요. + +html 파일에 대한 commit은 오로지 확장자를 바꾸는 것만 허용됩니다. 또한, 전체 commit 개수를 2개를 넘지 않도록 합니다(`squash and merge`가 아닌 `rebase and merge`를 해야하기 때문입니다.). `squash and merge`를 하거나 확장자 변경 작업이 없을 경우 Git History가 소멸되는데, 이전 기여자들의 기록을 남기기 위함입니다. 예시는 [확장자 변경 PR](https://github.com/mdn/translated-content/pull/1769/commits/c7937cf2194d218d98394cd7f5f8acebd2e88aa0)를 참고해주세요. + +다음 [PR](https://github.com/mdn/translated-content/pull/1771)은 모범적인 PR입니다. + +### 리뷰 + +리뷰로 인해 수정사항이 발생할 경우, 예외적으로 **수정 사항에 대해서 commit의 개수를 1개를 추가적으로 허용합니다.** + +> 참고 +> `git log --follow (파일)` 로 해당 파일의 git history를 볼 수 있습니다. + +## 그 이외의 경우 (이미 md 파일이 존재하거나, 해당 번역 페이지가 없는 경우) + +일반 PR 방식대로 진행합니다. + +# MDN ko locale Markdown 번역에 대한 일반 지침 (리뷰어) + +1. `존재하는 파일에 대한 변경 (존재하는 파일이 .html 확장자일 경우)`에 대해서는 `squash and merge`가 아닌 `rebase and merge`를 진행해야합니다. +2. 파일에 대한 Git History가 유지되는지 확인해주세요. +3. commit의 개수는 최소가 되어야 합니다. diff --git a/docs/ko/translation-guide.md b/docs/ko/translation-guide.md index 44898bdb04..f43ea8b627 100644 --- a/docs/ko/translation-guide.md +++ b/docs/ko/translation-guide.md @@ -89,6 +89,16 @@ EDITOR=code 그동안의 MDN 문서에서는 역주로인한 자의적인 해석이 많았고, 전체적인 문서의 품질을 낮췄습니다. 역주가 꼭 필요한 상황이 아니라면 역주는 남기지 않으며, 남기더라도 따로 역주를 표시하지 않고 본문에 포함합니다. 예시: [다음 링크 참고](https://github.com/mdn/translated-content/pull/1385#discussion_r667509255) +### 기울임꼴 + +한글은 기울임꼴에 적합하지 않습니다. 전용 이탤릭체가 없다는 것이 첫 이유이고, 문자의 조형이 (정)사각형인 것이 두 번째 이유입니다. [세부 내용 다음 링크 참고](https://github.com/mdn/translated-content/issues/1537) + +- 기본 방침은 생략하며, 기여자에 재량에 따라 아래 두 가지 규칙을 따른다. + - 한글일 경우 '' 를 tag 대신에 기입한다. + - 한글이 아닐 경우 생략한다. + +다만 진짜 강조를 해야하는 상황에는, 따옴표로 강조하고 PR로 소명합니다. + ## 용어 지침 ### 공통 |