diff --git a/CONTRIBUTING-kr.md b/CONTRIBUTING-kr.md index 8738bcaa77b28..b03583dded8be 100644 --- a/CONTRIBUTING-kr.md +++ b/CONTRIBUTING-kr.md @@ -1,61 +1,66 @@ -_다른 언어로 보기: [Français](CONTRIBUTING-fr.md), [English](CONTRIBUTING.md), [Español](CONTRIBUTING-es.md), [简体中文](CONTRIBUTING-zh.md), [繁體中文](CONTRIBUTING-zh_TW.md), [فارسی](CONTRIBUTING-fa_IR.md), [Tiếng Việt](CONTRIBUTING-vn.md), [Русский](CONTRIBUTING-ru.md), [한국어](CONTRIBUTING-kr.md)._ +*다른 언어로 보기: [Deutsch](CONTRIBUTING-de.md), [Français](CONTRIBUTING-fr.md), [English](CONTRIBUTING.md), [Español](CONTRIBUTING-es.md), [Italiano](CONTRIBUTING-it.md), [简体中文](CONTRIBUTING-zh.md), [繁體中文](CONTRIBUTING-zh_TW.md), [Português (BR)](HOWTO-pt_BR.md), [فارسی](CONTRIBUTING-fa_IR.md), [Русский](CONTRIBUTING-ru.md), [Bahasa Indonesia](CONTRIBUTING-id.md), [Tiếng Việt](CONTRIBUTING-vn.md), [한국어](CONTRIBUTING-kr.md).* + + ## 기여자 라이선스 합의 기여함으로써 귀하는 이 리포지토리의 다음 [라이선스](https://github.com/EbookFoundation/free-programming-books/blob/master/LICENSE) 사항에 동의합니다. + + ## 기여자 행동 강령 기여함으로써 귀하는 이 리포지토리의 다음 [행동강령](https://github.com/EbookFoundation/free-programming-books/blob/master/CODE_OF_CONDUCT-kr.md) 사항에 동의합니다. + + ## 요약 -1. "책을 쉽게 다운로드할 수 있는 링크"는 늘 _무료_ 책에 대한 링크는 아닙니다. 무료 콘텐츠만 제공해주세요. 무료인지 확인하세요. 우리는 책을 얻기 위해 유효한 이메일 주소를 *요구*하는 페이지에 대한 링크를 허용하지 않지만, 책을 요청하는 목록에는 환영합니다. - 2.Git을 알 필요는 없습니다. _이 리포지토리에 아직 없는_ 흥미로운 것을 발견했다면 제안하시는 링크를 포함한 [이슈](https://github.com/EbookFoundation/free-programming-books/issues) 여십시오. - - Git 사용이 가능하시다면 저장소를 포크하고 풀 리퀘스트를 보내주세요. -2. 5가지 종류의 목록이 있습니다. 올바른 것을 선택하십시오.: +1. "책을 쉽게 다운로드할 수 있는 링크"는 늘 *무료* 책에 대한 링크는 아닙니다. 무료 콘텐츠만 제공해주세요. 무료인지 확인하세요. 우리는 책을 얻기 위해 유효한 이메일 주소를 *요구*하는 페이지에 대한 링크를 허용하지 않지만, 책을 요청하는 목록에는 환영합니다. +2. Git을 알 필요는 없습니다. *이 리포지토리에 아직 없는* 흥미로운 것을 발견했다면 제안하시는 링크를 포함한 [이슈](https://github.com/EbookFoundation/free-programming-books/issues) 여십시오. + - Git 사용이 가능하시다면 저장소를 포크하고 풀 리퀘스트를 보내주세요. +3. 5가지 종류의 목록이 있습니다. 올바른 것을 선택하십시오.: - - _책_ : PDF, HTML, ePub, gitbook.io 사이트, Git 레포지토리, 등. - - _강의_ : 코스는 책이 아닌 학습 자료입니다. [이런게 강의입니다](http://rogerdudler.github.io/git-guide/index.ko.html). - - _상호적인 튜터리얼_ : 사용자가 코드나 명령을 입력하고 결과를 평가할 수 있는 대화형 웹사이트 ("평가"는 "등급"을 의미하지 않습니다.). 예: [Try Haskell](http://tryhaskell.org), [Try Github](http://try.github.io). - - _팟캐스트와 스크린캐스트_ : 팟캐스트와 스크린캐스트. - - _문제 세트 및 경쟁 프로그래밍_ : - 다른 사용자와 결과를 비교하거나 코드 검토를 포함하거나 단순 또는 복잡한 문제를 해결하여 프로그래밍 기술을 평가할 수 있는 웹 사이트 또는 소프트웨어입니다. + - *책* : PDF, HTML, ePub, gitbook.io 사이트, Git 레포지토리, 등. + - *강의* : 코스는 책이 아닌 학습 자료입니다. [이런게 강의입니다](http://rogerdudler.github.io/git-guide/index.ko.html). + - *상호적인 튜터리얼* : 사용자가 코드나 명령을 입력하고 결과를 평가할 수 있는 대화형 웹사이트 ("평가"는 "등급"을 의미하지 않습니다.). 예: [Try Haskell](http://tryhaskell.org), [Try Github](http://try.github.io). + - *팟캐스트와 스크린캐스트* : 팟캐스트와 스크린캐스트. + - *문제 세트 및 경쟁 프로그래밍* : 다른 사용자와 결과를 비교하거나 코드 검토를 포함하거나 단순 또는 복잡한 문제를 해결하여 프로그래밍 기술을 평가할 수 있는 웹 사이트 또는 소프트웨어입니다. -3. 아래 [가이드 지침](#guidelines)을 따르고 파일의 [마크다운 형식](#formatting)을 준수해야 합니다. +4. 아래 [가이드 지침](#guidelines)을 따르고 파일의 [마크다운 형식](#formatting)을 준수해야 합니다. -4. GitHub Actions는 목록이 알파벳순으로 정렬되어 있고 형식 지정 규칙을 준수하는지 확인하기 위해 테스트를 실행합니다. 변경 사항이 테스트를 통과했는지 확인하십시오. +5. GitHub Actions는 목록이 알파벳순으로 정렬되어 있고 형식 지정 규칙을 준수하는지 확인하기 위해 테스트를 실행합니다. 변경 사항이 테스트를 통과했는지 확인하십시오. - + ### 가이드 지침 - 책이 무료인지 확인하십시오. 필요한 경우 다시 확인하십시오. 당신의 책이 무료라고 생각하는 이유에 대해 PR에 댓글을 달면 관리자에게 도움이 됩니다. -- google drive, dropbox, mega, scribd, issuu 또는 유사한 파일 업로드 플랫폼에서 호스팅되는 파일은 허용하지 않습니다. +- Google Drive, Dropbox, Mega, Scribd, Issuu 또는 유사한 파일 업로드 플랫폼에서 호스팅되는 파일은 허용하지 않습니다. - 알파벳 순서로 링크를 삽입하십시오. 잘못된 링크가 있는 경우 다시 수정하여 PR을 제출하세요. - 가장 권위 있는 출처의 링크를 사용하십시오(작가의 웹사이트가 편집자의 웹사이트보다 우수하고 타사 웹사이트보다 우수함을 의미) -- 파일 호스팅 서비스 불가 (여기에는 Dropbox 및 Google Drive 링크가 포함되지만 이에 국한되지 않음) + + 파일 호스팅 서비스 불가 (여기에는 Dropbox 및 Google Drive 링크가 포함되지만 이에 국한되지 않음) - 동일한 도메인에 있고 동일한 콘텐츠를 제공하는 한 항상 `http` 링크보다 `https` 링크를 선호합니다. - 루트 도메인에서 후행 슬래시를 제거합니다: `http://example.com/` 대신 `http://example.com` - 항상 가장 짧은 링크를 선호: `http://example.com/dir/`가 `http://example.com/dir/index.html` 보다 좋습니다. -- URL 단축 링크 불가. + + URL 단축 링크 불가. - 일반적으로 "버전" 링크보다 "현재" 링크를 선호합니다: `http://example.com/dir/book/current/`가 `http://example.com/dir/book/v1.0.0/index.html` 보다 좋습니다. - 링크에 만료된 인증서/자체 서명된 인증서/다른 종류의 SSL 문제가 있는 경우: - 1. _교체 하십시오_: 가능하면 `http`로 대체합니다(모바일 장치에서는 예외를 수락하는 것이 복잡할 수 있기 때문에). - 2. _그대로 두십시오_: 사용 가능한 `http` 버전이 없다면 브라우저에 예외를 추가하거나 경고를 무시하여 `https`를 통해 링크에 계속 액세스할 수 있는 경우 그대로 두십시오. - 3. 아니라면 _제거하십시오_. + 1. *교체 하십시오*: 가능하면 `http`로 대체합니다(모바일 장치에서는 예외를 수락하는 것이 복잡할 수 있기 때문에). + 2. *그대로 두십시오*: 사용 가능한 `http` 버전이 없다면 브라우저에 예외를 추가하거나 경고를 무시하여 `https`를 통해 링크에 계속 액세스할 수 있는 경우 그대로 두십시오. + 3. 아니라면 *제거하십시오*. - 링크가 여러 형식으로 존재하는 경우 각 형식에 대한 메모와 함께 별도의 링크를 추가하십시오. - 리소스가 인터넷의 다른 위치에 있는 경우: - - 가장 권위 있는 출처의 링크를 사용하십시오(작가의 웹사이트가 편집자의 웹사이트보다 낫다는 의미) - - 다른 에디션으로 연결되어 있고 이 에디션이 소장 가치가 있을 만큼 충분히 다르다고 판단되면 각 에디션에 대한 메모가 포함된 별도의 링크를 추가하십시오. ([Issue #2353](https://github.com/EbookFoundation/free-programming-books/issues/2353)를 확인하여 형식 관련 논의에 기여하십시오.) + + 가장 권위 있는 출처의 링크를 사용하십시오(작가의 웹사이트가 편집자의 웹사이트보다 낫다는 의미) + + 다른 에디션으로 연결되어 있고 이 에디션이 소장 가치가 있을 만큼 충분히 다르다고 판단되면 각 에디션에 대한 메모가 포함된 별도의 링크를 추가하십시오. ([Issue #2353](https://github.com/EbookFoundation/free-programming-books/issues/2353)를 확인하여 형식 관련 논의에 기여하십시오.) - 더 큰 커밋보다 원자적 커밋(추가/삭제/수정에 의한 하나의 커밋)을 선호합니다. PR을 제출하기 전에 커밋을 스쿼시할 필요가 없습니다. (이 규칙은 관리자의 편의를 위한 것이기에 절대로 필수적이지는 않습니다.) - 오래된 책일 경우 제목과 함께 발행일을 포함합니다. - 적절한 경우 저자 이름을 포함합니다. "et al."을 사용하여 저자 목록을 줄일 수 있습니다. - 책이 완성되지 않았고 아직 작업 중인 경우 [아래 설명](#in_process)된 대로 "진행 중" 표기법을 추가하십시오. - 다운로드가 활성화되기 전에 이메일 주소 또는 계정 설정이 요청된다면 괄호 안에 언어에 맞는 메모를 추가하십시오., 예: `(이메일 주소 *요청됨*, 필요 없음)` - + ### 형식 - 모든 목록은 `.md` 파일입니다. [마크다운](https://guides.github.com/features/mastering-markdown/) 문법을 배워보세요. 간단합니다! @@ -87,7 +92,7 @@ BAD : * [다른 재밌는 책] (http://example.com/book.html) GOOD: * [다른 재밌는 책](http://example.com/book.html) ``` -- 저자를 포함한다면 `-` 를 사용하십시오 (단일 공백으로 둘러싸인 대시): +- 저자를 포함한다면 ` - ` 를 사용하십시오 (단일 공백으로 둘러싸인 대시): ``` BAD : * [다른 재밌는 책](http://example.com/book.html)- 홍길동 @@ -124,27 +129,34 @@ GOOD: * [너무 재밌는 책 (1970)](https://example.org/book.html) - 홍진성 ``` - - 진행 중인 책: ``` GOOD: * [곧 아주 재밌을 책](http://example.com/book2.html) - 홍길동 (HTML) (:construction: *진행중*) ``` + + ### 노트 기본 사항은 비교적 간단하지만 나열한 리소스에는 매우 다양합니다. 다음은 이러한 다양성을 처리하는 방법에 대한 몇 가지 참고 사항입니다. + + #### 메타데이터 -우리 목록은 제목, URL, 작성자, 플랫폼 및 액세스 정보와 같은 최소한의 메타데이터 집합을 제공합니다. +우리 목록은 제목, URLs, 작성자, 플랫폼 및 액세스 정보와 같은 최소한의 메타데이터 집합을 제공합니다. + + ##### 제목 - 발명된 제목이 없습니다. 리소스 자체에서 제목을 가져오려고 합니다. 기고자는 제목을 만들거나 피할 수 있는 경우 편집용으로 사용하지 말 것을 권고합니다. 오래된 작품은 예외입니다. 주로 역사적 관심이 있는 경우 제목에 괄호 안에 연도를 추가하면 사용자가 관심이 있는지 알 수 있습니다. - ALLCAPS 타이틀이 없습니다. 일반적으로 제목 대소문자가 적절하지만 의심스러운 경우 출처의 대문자를 사용합니다. -##### URL + + +##### URLs - 단축 URL은 허용되지 않습니다. - URL에서 추적 코드를 제거해야 합니다. @@ -152,24 +164,32 @@ GOOD: * [곧 아주 재밌을 책](http://example.com/book2.html) - 홍길동 (H - 보안(https) URL은 https가 구현된 비보안(http) URL보다 항상 선호됩니다. - 우리는 나열된 리소스를 호스팅하지 않고 대신 다른 곳을 가리키는 웹페이지를 가리키는 URL을 좋아하지 않습니다. + + ##### 제작자들 - 번역가를 포함하여 적절한 경우 무료 리소스의 제작자에게 공을 돌리고 싶습니다! - 또는 번역된 작품은 원저자가 표시되어야 합니다. - 크리에이터에 대한 링크는 허용하지 않습니다. -- 편집 또는 리믹스된 작품의 경우 "제작자"에 대한 설명이 필요할 수 있습니다. 예를 들어 "GoalKicker" 책은 "StackOverflow 문서에서 컴파일됨"으로 표시됩니다. +- 편집 또는 리믹스된 작품의 경우 "제작자"에 대한 설명이 필요할 수 있습니다. 예를 들어 "GoalKicker" 책은 "StackOverflow 문서에서 컴파일됨" 으로 표시됩니다. + + ##### 플랫폼 및 액세스 참고 사항 - 강의 또는 코스. 특히 강의 목록의 경우 플랫폼은 리소스 설명의 중요한 부분입니다. 코스 플랫폼마다 어포던스와 액세스 모델이 다르기 때문입니다. 일반적으로 등록이 필요한 책은 나열하지 않지만 많은 코스 플랫폼에는 일종의 계정 없이는 작동하지 않는 어포던스가 있습니다. 코스 플랫폼의 예에는 Coursera, EdX, Udacity 및 Udemy가 있습니다. 과정이 플랫폼에 종속되는 경우 플랫폼 이름은 괄호 안에 나열되어야 합니다. -- 유튜브. YouTube 재생 목록으로 구성된 많은 과정이 있습니다. YouTube를 플랫폼으로 나열하지 않고 종종 하위 플랫폼인 Youtube 제작자를 나열하려고 합니다. +- 유튜브. YouTube 재생 목록으로 구성된 많은 과정이 있습니다. YouTube를 플랫폼으로 나열하지 않고 종종 하위 플랫폼인 YouTube 제작자를 나열하려고 합니다. - 유튜브 동영상. 우리는 일반적으로 1시간 이상 길이가 코스나 튜토리얼처럼 구성되지 않는 한 개별 YouTube 동영상에 링크하지 않습니다. - 린펍. Leanpub은 다양한 액세스 모델로 책을 호스팅합니다. 때로는 등록 없이도 책을 읽을 수 있습니다. 때때로 책은 무료 액세스를 위해 Leanpub 계정이 필요합니다. 책의 품질과 Leanpub 액세스 모델의 혼합 및 유동성을 고려할 때 액세스 메모 *(Leanpub 계정 또는 유효한 이메일 요청)*과 함께 후자의 목록을 허용합니다. + + #### 장르 리소스가 속한 목록을 결정하는 첫 번째 규칙은 리소스가 자체적으로 설명하는 방식을 확인하는 것입니다. 그것이 스스로를 책이라고 부른다면 아마도 그것은 책일 것입니다. + + ##### 포함하지 않은 장르 인터넷은 방대하기 때문에 목록에 포함하지 않습니다: @@ -186,6 +206,8 @@ GOOD: * [곧 아주 재밌을 책](http://example.com/book2.html) - 홍길동 (H 우리의 경쟁 프로그램 목록은 이러한 제외에 대해 엄격하지 않습니다. 리포지토리의 범위는 커뮤니티에서 결정합니다. 범위에 대한 변경이나 추가를 제안하려면 이슈를 사용하여 제안하십시오. + + ##### 책 vs. 기타 리소스 우리는 책에 그렇게 까다롭지 않습니다. 다음은 리소스가 책임을 나타내는 몇 가지 속성입니다: @@ -200,25 +222,31 @@ GOOD: * [곧 아주 재밌을 책](http://example.com/book2.html) - 홍길동 (H 이러한 속성이 없는 많은 책이 나열되어 있습니다. 컨텍스트에 따라 달라질 수 있습니다. + + ##### 책 vs. 강의 때때로 이것들은 구별하기 어려울 수 있습니다! 코스에는 종종 관련 교과서가 있으며, 이는 우리의 도서 목록에 나열됩니다. 코스에는 강의, 연습, 테스트, 메모 또는 기타 교훈적인 보조 자료가 있습니다. 하나의 강의나 비디오 자체는 강의가 아닙니다. 파워포인트는 강의가 아닙니다. + + ##### 상호적인 튜터리얼 vs. 기타 리소스 인쇄하여 본질을 유지할 수 있다면 대화형 자습서가 아닙니다. + + ### 자동화 - 서식 규칙 적용은 [fpb-lint](https://github.com/vhf/free-programming-books-lint)를 사용하여 [GitHub Actions](https://github.com/features/actions)를 통해 자동화됩니다. [.github/workflows/fpb-lint.yml](.github/workflows/fpb-lint.yml) 참조) - URL 유효성 검사는 [awesome_bot](https://github.com/dkhamsing/awesome_bot)을 사용합니다. - URL 유효성 검사를 트리거하려면 `check_urls=file_to_check`가 포함된 커밋 메시지가 포함된 커밋을 푸시합니다.: -``` -check_urls=free-programming-books.md free-programming-books-en.md -``` + ``` + check_urls=free-programming-books.md free-programming-books-en.md + ``` - 각 항목을 구분하는 단일 공백을 사용하여 검사할 파일을 두 개 이상 지정할 수 있습니다. - 파일을 2개 이상 지정할 경우, 마지막으로 확인한 파일의 결과를 기준으로 빌드 결과가 결정됩니다. 이로 인해 녹색 빌드를 통과할 수 있으므로 "모든 검사 표시" -> "세부 정보"를 클릭하여 풀 요청이 끝날 때 빌드 로그를 검사해야 합니다.