기여하기 문서 추가 related #8

Author: 9bow

CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# 기여하기
+
+[[한국어](CONTRIBUTING.md)]
+
+:+1::tada: KOMORAN 문서 프로젝트에 관심을 갖고 기여해주셔서 감사합니다! :tada::+1:
+
+이 문서는 [KOMORAN 문서 프로젝트](https://github.com/shineware/KOMORANDocs)에 기여하고 싶은 분들을 위해 작성되었습니다.
+이 문서에 담긴 내용들은 대부분 **요청사항**에 가까우며 반드시 따르셔야 하는 것은 아닙니다.
+필요하다고 생각하시는 경우 언제든지 다른 방법으로 기여해주셔도 되며, 이 문서 또한 그러한 기여의 대상입니다.
+(관련 Issue가 있는) Pull Request는 언제든 환영입니다. :D
+
+## 질문하기
+
+먼저, 이 문서 또는 이 저장소와 관련한 전반적인 질문은 [Issue 메뉴](https://github.com/shineware/KOMORANDocs/issues)를 이용해 주시기 바랍니다.
+일부 프로젝트는 Issue 메뉴를 공식적인 목적으로 사용하지만, 저희는 한 곳에서 모든 일들이 처리되길 바랍니다.
+
+## Issue 우선주의
+
+### **모든 기여는 Issue로부터 시작**되어야 합니다.
+
+[KOMORAN 문서 프로젝트](https://github.com/shineware/KOMORANDocs)는 Issue를 이용하여 의견을 교환하고, 결정된 사항을 관리합니다.
+따라서 문제점 또는 개선 사항에 대한 Issue가 존재하는지 [Issue 메뉴](https://github.com/shineware/KOMORANDocs/issues)에서 찾아보시거나, 올려주세요!
+
+### 문제점 또는 개선점을 발견하셨나요?
+
+올려주신 Issue를 통해 실제로 기여를 시작하시기 전에 의견 교환이 이뤄지게 됩니다.
+이 과정에서 기여자가 생각하는 문제점 또는 개선 사항에 대해 다른 사람이 어떻게 생각하는지를 알 수 있으며,
+프로젝트 관리자가 문제점이나 개선 사항이 아니라고 생각하는 경우에는 Issue가 받아들여지지 않을 수도 있습니다.
+따라서 Issue를 작성하시기 전에, 비슷한 문제에 대해서 이미 의논이 되었는지를 확인하시면 더욱 좋습니다.
+
+또한, Issue를 올렸다고 해서 (Issue를 올린 사람이) 반드시 책임을 져야 하는 것도 아닙니다.
+언제든 문제점 또는 개선 사항을 발견하셨다면 보인다면 편하게 [Issue 메뉴](https://github.com/shineware/KOMORANDocs/issues)에 올려주세요.
+
+### 해결하기 적당한 Issue를 찾고 계신가요?
+
+기여하기에 적절한 Issue를 찾고 계신가요?
+[[Help Wanted]](https://github.com/shineware/KOMORANDocs/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) 또는
+[[Good First Issue]](https://github.com/shineware/KOMORANDocs/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)에
+아직 해결되지 않은 Issue들이 기다리고 있습니다. :D
+
+## 개선 요청하기 (Pull Request)
+
+Issue를 만드시거나 발견하셨나요? 이제 직접 코드를 수정하시고 개선을 요청(Pull Request)하실 수 있습니다.
+GitHub에서 저장소를 복제(Fork)하고 코드를 수정하는 과정은 이 문서의 범위를 벗어나기 때문에 따로 설명하지는 않겠습니다.
+(기본적인 사용법은 [검색 엔진에서 사용법을 검색](https://www.google.com/search?q=GitHub+Pull+Request+사용법)하시는 것을 권장합니다.)
+
+개선 요청을 위한 Pull Request를 보내실 때에는, `이슈 번호`를 반드시 Commit 메시지의 맨 앞 또는 맨 뒤에 포함시켜주십시오.
+어떠한 Commit이 어떠한 Issue와 관련되었는지를 나중에 누구든 확인할 수 있게 하기 위함입니다.
+
+KOMORAN 문서 프로젝트를 로컬 환경에서 빌드하고 개선 사항을 확인하는 방법은 [README 문서](https://github.com/shineware/KOMORANDocs#실행하기)를 참고해주시기 바랍니다.
+
+## 지켜주세요 (Code of Conduct)
+
+긍정적인 환경을 조성하기 위해, 상대방의 입장에서 먼저 생각하고 서로를 존중해주시기 바랍니다.
+법을 위반하거나 부적절한 언행이나 행동을 하시는 경우 프로젝트 관리자에 의해 제재를 받으실 수 있습니다.

README.md

@@ -1,46 +1,55 @@
-## KOMORAN 문서
+# KOMORAN 문서
 
-### 소개
+## 소개
 
 https://docs.komoran.kr
 
 * 이 저장소는 [KOMORAN 문서와 튜토리얼 등을 위한 정적 사이트(Static site)](https://docs.komoran.kr)를 생성/관리하기 위해 만들었습니다.
 * [Sphinx](http://www.sphinx-doc.org/en/master/)과 [GitHub Pages](https://pages.github.com/)를 이용하고 있습니다.
 
-
-### 실행하기
+## 실행하기
 
 이 저장소를 직접 실행해보기 위해서는 다음과 같은 과정을 거쳐야 합니다.
 
-#### 환경 준비
-* Python 3.x
+### 환경 준비
+
+* Python 3.x 이상
 * pip (for Python 3.x)
 
-#### 저장소 복제
+### 저장소 복제
 먼저 저장소를 복제합니다. Git 사용법은 [여기](https://git-scm.com/book/ko/)를 참고해주시기 바랍니다.
+
 ```sh
-  git clone https://github.com/komoran/docs
+  git clone https://github.com/shineware/KOMORANDocs
   cd docs
 ```
 
-#### 의존성 설치
+### 의존성 설치
+
 pip를 이용하여 의존성을 갖는 패키지들을 설치합니다.
+
 ```sh
   pip install -r requirements.txt
 ```
 
-#### 문서 수정
+### 문서 수정
+
 Sphinx는 reST(reStructuredText)를 사용하고 있습니다.
 간단한 reST 문법은 [여기](http://docutils.sourceforge.net/docs/user/rst/quickref.html)에서 확인하실 수 있습니다.
 
-#### 빌드하기
+### 빌드하기
+
 수정한 문서를 확인하기 위해서는 다음과 같이 정적 사이트를 빌드해야 합니다.
+
 ```sh
   make html
 ```
+
 생성된 결과물은 `_build/html` 경로에서 확인하실 수 있습니다.
 
 
-### 기여하기
+## 기여하기
+
+문제점 또는 개선점을 찾으셨나요? 또는 KOMORAN 문서 사이트에 기여하고 싶으신가요?
 
-[KOMORAN 문서](https://docs.komoran.kr)를 보시다가 고쳐야 할 부분이 있다면 위 내용을 참고하시어 문서를 수정, 확인 하신 후 [Pull Request](https://help.github.com/en/articles/about-pull-requests)를 남겨주세요.
+[기여하기](CONTRIBUTING.md) 문서를 참고해주세요!