Update CONTRIBUTING.md #378

hyoyoung · 2021-11-11T13:24:23Z

컨트리뷰톤 기여자들의 내용 추가

라이선스 동의

변경해주시는 내용에 BSD 3항 라이선스가 적용됨을 동의해주셔야 합니다.

더 자세한 내용은 기여하기 문서를 참고해주세요.

동의하시면 아래 [ ]를 [x]로 만들어주세요.

기여하기 문서를 확인하였으며, 본 PR 내용에 BSD 3항 라이선스가 적용됨에 동의합니다.

PR 종류

이 PR에 해당되는 종류 앞의 [ ]을 [x]로 변경해주세요.

오탈자를 수정하거나 번역을 개선하는 기여
번역되지 않은 튜토리얼을 번역하는 기여
공식 튜토리얼 내용을 반영하는 기여
위 종류에 포함되지 않는 기여

PR 설명

컨트리뷰톤 활동에 따른 기여하기 문서 개선

컨트리뷰톤 기여자들의 내용 추가

9bow

내용에 이견은 없지만, 순서나 추가해야 할 내용들이 더 있을거 같습니다.
제가 improve_contribdocs 브랜치에 추가 커밋하겠습니다.

9bow · 2021-11-12T17:28:13Z

CONTRIBUTING.md

+### Pull Reqeust 만들기
+
+#### Pull Request 만들기 전 : 주의사항
+
+* 하나의 commit, branch, Pull Request(PR)에는 하나의 변경 사항만 담아주세요.
+  * 여러 수정사항에 대해서는 각각 다른 branch에서 작업하신 뒤, 새로운 PR을 만들어주세요.
+  * 새로운 branch가 아닌, 이미 PR를 만드셨던 branch에 추가 commit 시에는 이전 commit들과 함께 Pull Request가 생성됩니다.
+* Pull Request를 만들기 문법 오류나 깨진 글자는 없는지 확인해주세요.
+  * 기본적인 문법은 [Quick reStructredText](https://docutils.sourceforge.io/docs/user/rst/quickref.html) 등의 문서를 참고하여 익혀주세요.
+  * 이미 번역된 문서들을 참고하셔도 좋습니다. (예. \` 뒤에 한글 작성 시 공백 또는 \\이 필요합니다.)
+  * 번역 후에는 `make html-noplot` 등의 명령어로 문법 오류를 확인해주세요.
+    * 번역 결과물에 \`, * 또는 _ 등의 기호를 검색하면 자주 실수하는 문법 오류를 쉽게 찾을 수 있습니다.
+* 오류가 많거나 다른 PR의 commit이 섞여있는 경우 해당 PR은 관리자가 닫을 수 있으니 주의해주세요.
+
+#### Pull Request 만들기 : 생성하기
+
+* `라이선스 동의` 체크하기 ✅
+  * 기여해주신 내용을 더 많은 분들이 참고 / 개선 / 변경할 수 있게 라이선스 적용에 동의해주세요.
+  * 동의를 거부하실 수 있으나, 이 경우 해당 PR의 내용의 자유로운 사용이 어렵기 때문에 리뷰 및 반영은 진행하지 않습니다.
+* PR 내용에 관련 이슈 번호 적어주기 🔢
+  * 논의된 내용이 있다면 참고할 수 있도록 어떠한 이슈로부터 생성한 PR인지 알려주세요.
+* PR 종류 선택하기
+  * 리뷰어에게 어떤 종류의 PR인지 알려주세요.
+* PR 설명하기
+  * 이 PR을 통해 어떠한 것들이 변경되는지 알려주세요.
+* **Tip**: 만약 문서가 방대해서 중간 피드백이 필요하다면 Draft PR 기능을 사용할 수 있습니다.
+  * 자세한 내용은 [GitHub Blog](https://github.blog/2019-02-14-introducing-draft-pull-requests/)의 글을 참고해주세요.
+
+#### Pull Request 만든 후 : 리뷰를 받았을 때
+
+* 리뷰 내용에 대한 추가 의견이 있을 경우 해당 리뷰에 댓글로 의견을 주고 받습니다.
+  * 번역한 문서의 내용은 번역자가 가장 잘 알고 있으므로 리뷰어의 의견에 반드시 따라야 하는 것은 아닙니다.
+  * 하지만 번역 실수나 오류, 잘못된 reStructuredText 문법에 대한 내용은 가급적 반영해주시기를 부탁드립니다.
+  * 다른 문서들과의 일관성, 이해를 위해 추가로 요청드리는 내용들도 있을 수 있으니 감안해주세요.
+* 변경 사항을 고치기로 하였다면, Pull Request를 만든 원본 저장소 / branch에 추가 commit을 합니다.
+  * 리뷰 결과를 반영한 경우 `Resolve Conversation` 버튼을 눌러 리뷰어에게 알립니다.
+
+### Pull Request 리뷰하기
+
+* 리뷰 전 [TRANSLATION_GUIDE.md](TRANSLATION_GUIDE.md) 문서를 읽고 리뷰해주세요.
+* 특히 다음의 내용들을 유의해주세요.
+  * 번역된 용어들이 용어집에 맞게 사용되었는지 확인합니다.
+  * 번역된 내용에 오탈자가 있는지 확인해 봅니다.
+  * 부자연스러운 내용이 있다면 좀 더 나은 번역으로 제안하여 봅니다.
+  * reStructuredText 문법에 맞게 잘 작성되어있는지 확인해 봅니다.
+* 말하려는 내용이 이미 다른 댓글에 있다면 공감 이모지 눌러주세요.


추가해주셨던 PR 만들기 / 리뷰하기 내용을 기여하기 절차 아래에 포함하였습니다.
각 단계로 나누는 것이 적절할 것 같아 줄 글을 목록으로 바꾸면서 소소하게 내용들을 추가 / 개선하였습니다.

9bow · 2021-11-12T17:28:34Z

CONTRIBUTING.md

-#### 1-6. Pull Request 남기기
+#### 1-6. Pull Request 만들기


Issue는 남기고, PR은 만드는 것으로 변경하였습니다.

9bow · 2021-11-12T17:28:59Z

CONTRIBUTING.md


 수정을 완료한 내용을 복제한 저장소에 Commit 및 Push하고, Pull Request를 남깁니다. \
-Pull Request가 처음이시라면 [GitHub의 Pull Request 소개 도움말](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) 및 [복제한 저장소로부터 Pull Request 만들기 도움말](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork)을 참조해주세요.
+Pull Request를 만드시기 전에 이 문서에 포함된 [Pull Request 만들기](#Pull-Request-만들기) 부분을 반드시 읽어주세요. \


위에서 작성한 Pull Request 만들기 부분을 참고할 수 있도록 내용을 추가하였습니다.

9bow · 2021-11-12T17:29:04Z

CONTRIBUTING.md


 번역을 완료한 내용을 복제한 저장소에 Commit 및 Push하고, Pull Request를 남깁니다. \
-Pull Request가 처음이시라면 [GitHub의 Pull Request 소개 도움말](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) 및 [복제한 저장소로부터 Pull Request 만들기 도움말](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork)을 참조해주세요.
+Pull Request를 만드시기 전에 이 문서에 포함된 [Pull Request 만들기](#Pull-Request-만들기) 부분을 반드시 읽어주세요. \


위에서 작성한 Pull Request 만들기 부분을 참고할 수 있도록 내용을 추가하였습니다.

9bow · 2021-11-12T17:29:11Z

CONTRIBUTING.md


 Pull Request된 문서의 오탈자 수정, reStructuredText 문법 오류 또는 잘못 번역된 내용을 개선하는 기여로, 가장 기다리고 있는 기여 방식입니다. :pray: \
-PR 리뷰가 익숙하지 않으시다면 [GitHub의 Pull Request 리뷰 관련 도움말](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews)을 참조해주세요.
+Pull Request를 리뷰하시기 전에 이 문서에 포함된 [Pull Request 리뷰하기](#Pull-Request-리뷰하기) 부분을 반드시 읽어주세요. \


위에서 작성한 Pull Request 리뷰하기 부분을 참고할 수 있도록 내용을 추가하였습니다.

9bow · 2021-11-12T17:30:41Z

TRANSLATION_GUIDE.md

-# 번역 규칙
-첫번째로 해당 용어가 출현하였을 때는 '한글(영어)'로 번역하고, 이후부터는 한글로만 번역합니다. (예. including transposing, indexing, ... => 전치(transposing), 인덱싱(indexing), ...)		


기존 번역 규칙 부분을 일반 규칙으로 변경하고, CONTRIBUTING.md 문서에 추가해주셨던 번역 스타일링 부분을 변경 / 개선하여 아래 포함하였습니다.

9bow · 2021-11-12T17:31:19Z

TRANSLATION_GUIDE.md

+# 용어 사용 규칙
+
+1. 아래 용어가 적절하면 가급적 아래 표의 용어를 사용합니다.
+1. 지정된 용어가 없다면 아래 사이트를 참고하여 사용합니다.
+  * http://www.ktword.co.kr/
+  * https://github.com/keunwoochoi/machine_learning_eng2kor/blob/master/dictionary.md
+1. 적절한 용어가 없으면 적절한 단어를 새로 사용하고, 아래 목록에 내용을 추가합니다.


용어 사용 규칙 부분은 이후에 있을 용어집 개선을 고려하여 추가 개선은 하지 않았습니다.

9bow · 2021-11-12T17:35:30Z

+ PR 본문의 라이선스 동의 부분을 확인해주세요. 😏

Update CONTRIBUTING.md

d76aa8c

컨트리뷰톤 기여자들의 내용 추가

hyoyoung requested a review from 9bow November 11, 2021 13:24

9bow requested changes Nov 12, 2021

View reviewed changes

9bow self-assigned this Nov 12, 2021

기여하기 및 번역 가이드 문서 개선 - PR 만들기 / 리뷰하기 / 번역 규칙 추가

2af4994

9bow reviewed Nov 12, 2021

View reviewed changes

hyoyoung requested a review from 9bow November 13, 2021 12:55

9bow approved these changes Nov 13, 2021

View reviewed changes

9bow merged commit 9b2d730 into master Nov 13, 2021

9bow deleted the improve_contribdocs branch November 13, 2021 13:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update CONTRIBUTING.md #378

Update CONTRIBUTING.md #378

Uh oh!

hyoyoung commented Nov 11, 2021 •

edited

Loading

Uh oh!

9bow left a comment

Uh oh!

9bow Nov 12, 2021

Uh oh!

9bow Nov 12, 2021

Uh oh!

9bow Nov 12, 2021

Uh oh!

9bow Nov 12, 2021

Uh oh!

9bow Nov 12, 2021

Uh oh!

9bow Nov 12, 2021

Uh oh!

9bow Nov 12, 2021

Uh oh!

9bow commented Nov 12, 2021 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		#### 1-6. Pull Request 남기기
		#### 1-6. Pull Request 만들기

		# 번역 규칙
		첫번째로 해당 용어가 출현하였을 때는 '한글(영어)'로 번역하고, 이후부터는 한글로만 번역합니다. (예. including transposing, indexing, ... => 전치(transposing), 인덱싱(indexing), ...)

Update CONTRIBUTING.md #378

Update CONTRIBUTING.md #378

Uh oh!

Conversation

hyoyoung commented Nov 11, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

라이선스 동의

관련 이슈 번호

PR 종류

PR 설명

Uh oh!

9bow left a comment

Choose a reason for hiding this comment

Uh oh!

9bow Nov 12, 2021

Choose a reason for hiding this comment

Uh oh!

9bow Nov 12, 2021

Choose a reason for hiding this comment

Uh oh!

9bow Nov 12, 2021

Choose a reason for hiding this comment

Uh oh!

9bow Nov 12, 2021

Choose a reason for hiding this comment

Uh oh!

9bow Nov 12, 2021

Choose a reason for hiding this comment

Uh oh!

9bow Nov 12, 2021

Choose a reason for hiding this comment

Uh oh!

9bow Nov 12, 2021

Choose a reason for hiding this comment

Uh oh!

9bow commented Nov 12, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

hyoyoung commented Nov 11, 2021 •

edited

Loading

9bow commented Nov 12, 2021 •

edited

Loading