콘텐츠로 이동

처음 기여자를 위한 가이드

__모두는 어느 한 곳에서 시작합니다. 만약 이것이 처음으로 오픈 소스 문서를 GitHub에서 기여하는 것이라면, 이 첫 걸음을 진심으로 축하합니다. 우리는 여러분이 무엇을 말하고자 하는지 기대하고 있습니다!_

Git and GitHub

우리의 기여자 지침은 GitHub 계정을 가지고 있다고 가정합니다. 만약 아직 계정이 없다면, 지금이 좋은 시기입니다. 12분이라도 있다면, Udemy의 초보자를 위한 Git 및 GitHub 초보자 가이드를 통해 GitHub이 무엇인지에 대해 기본적인 내용을 배울 수 있습니다.

처음에는 Rocky Linux를 위한 저장소를 만들고 관리하지 않을 수 있습니다. 하지만 Hello World 튜토리얼을 따라가며 GitHub 계정을 생성하고 용어를 익히며 저장소가 어떻게 작동하는지 이해할 수 있습니다. 기존 문서를 업데이트하고 커밋하고 Pull Request를 생성하는 방법을 익히는 데 집중하세요.

Markdown

Markdown은 간단한 언어로 동일한 파일에 서식, 코드, 일반 텍스트를 포함할 수 있게 해줍니다. 문서를 업데이트하는 첫 번째 시도에서는 기존 코드를 따라 하시면 됩니다. 곧 추가적인 기능을 탐색할 준비가 될 것입니다. 그 때를 위해 기본 사항을 안내해 드립니다.

로컬 리포지토리 편집기

로컬 저장소를 만들려면 먼저 컴퓨터와 운영 체제에 맞는 마크다운 편집기를 찾아 설치하세요. 아래는 몇 가지 옵션입니다만, 다른 옵션도 있습니다. 자신이 알고 있는 것을 사용하세요.

  • ReText - 무료, 교차 플랫폼 및 오픈 소스
  • Zettlr - 무료, 교차 플랫폼 및 오픈 소스
  • MarkText - 무료, 교차 플랫폼 및 오픈 소스
  • Remarkable - Linux 및 Windows, 오픈 소스
  • NvChad vi/vim 사용자 및 nvim 클라이언트용. 마크다운 편집기를 향상시키기 위해 많은 플러그인을 사용할 수 있습니다. 유용한 설치 지침은 이 문서를 참조하세요.
  • VS Code - 부분적으로 Microsoft에서 공개한 소스입니다. VS Code는 Windows, Linux 및 MacOS에서 사용할 수 있는 가볍고 강력한 편집기입니다. 이 문서 프로젝트에 기여하려면 Git Graph, HTML 미리보기, HTML 스니펫, Markdown All in One, Markdown Preview Enhanced, Markdown Preview Mermaid 지원 등의 확장 프로그램을 받아야 합니다.

로컬 리포지토리 만들기

마크다운 편집기를 설치했다면, 해당 편집기를 GitHub 계정에 연결하고 저장소를 로컬 컴퓨터로 다운로드하는 방법을 따르세요. 문서를 업데이트할 준비를 할 때마다 다음 단계를 따라 로컬 및 온라인 포크를 주 브랜치와 동기화하여 최신 버전으로 작업하는지 확인하세요:

  1. GitHub 내에서 설명서 리포지토리의 포크를 기본 브랜치와 동기화합니다.
  2. Markdown 편집기 지침에 따라 현재 포크를 로컬 컴퓨터와 동기화합니다.
  3. Markdown 편집기 내에서 수정하려는 문서를 엽니다.
  4. 문서를 수정합니다.
  5. 저장합니다.
  6. 편집기 내에서 변경 사항을 커밋하면 로컬 리포지토리가 온라인 포크와 동기화됩니다.
  7. GitHub 내에서 포크에서 업데이트된 문서를 찾고 끌어오기 요청을 생성하여 이를 기본 문서와 병합합니다.

업데이트 제출

누락된 단어를 추가하거나 오류를 수정하거나, 혼란스러운 부분을 명확히 설명하세요.

  1. 업데이트하려는 페이지에서 시작하세요.

    업데이트하려는 문서의 우측 상단에 있는 "편집" 연필 아이콘을 클릭하면 해당 문서가 GitHub에서 원본 문서로 열립니다. GitHub의 원본 문서로 이동합니다.

    RL 저장소에 처음 기여하는 경우 "이 저장소를 포크하고 변경 사항을 제안합니다"라는 초록색 버튼이 표시됩니다. 이 버튼을 클릭하면 RL 저장소의 복제본이 생성되고 여기에서 제안한 수정을 수행할 수 있습니다. 단순히 초록색 버튼을 클릭하고 계속하세요.

  2. 변경 사항 만들기

    마크다운 형식을 따르세요. 예를 들어, 누락된 단어나 21번 줄에 있는 링크를 수정해야 할 수도 있습니다. 필요한 변경 사항을 수행하세요.

  3. 변경 사항 제안하기

    페이지 하단에 변경 사항 제안이라는 블록 제목에 한 줄로 설명을 작성합니다. 제목에서 문서 상단에 있는 파일 이름을 참조하는 것이 도움이 되지만 필수는 아닙니다.

    따라서 마크다운 텍스트의 21번 줄 내부의 링크를 업데이트했다면 "README.md에 올바른 링크 업데이트"와 같은 내용을 작성하면 됩니다.

    참고: 동작을 현재 시제로 표현하세요.

    그런 다음 "변경 사항 제안"을 클릭하여 변경 사항을 포크한 저장소의 완전한 문서로 커밋합니다.

  4. 변경 사항 검토하기

    이제 수행한 작업을 한 줄씩 볼 수 있습니다. 무엇인가 빠뜨렸나요? 이전 페이지로 돌아가서 다시 수정하세요(처음부터 다시 시작해야 합니다). 그런 다음 다시 "변경 사항 제안"을 클릭하세요.

    문서가 원하는대로 완성되면 "풀 리퀘스트 생성"이라고 쓰여진 녹색 버튼을 클릭하세요. 이렇게 한 번 더 변경 사항을 확인하고 문서가 준비되었는지 확인하는 기회를 더 제공합니다.

  5. 풀 리퀘스트 생성

    지금까지의 모든 작업은 여러분의 저장소에서 이루어졌고, RL 주 저장소를 깨뜨릴 기회가 없었습니다. 이제 이를 문서 팀에 제출하여 여러분의 버전을 문서의 주 버전으로 병합하게 됩니다.

    "풀 리퀘스트 생성"이라고 쓰여진 큰 녹색 버튼을 클릭하세요. 좋은 소식입니다. 여전히 무언가를 깨뜨리지는 않았습니다. 이제 RL 문서 팀이 확인하도록 합니다.

  6. 기다리기.

    RL 팀이 여러분의 요청을 받으면 세 가지 방법 중 하나로 응답할 것입니다.

    • 풀 리퀘스트를 승인하고 병합
    • 피드백을 주고 변경 사항을 요청
    • 설명과 함께 PR 거부

    마지막 응답은 드물 것입니다. 여러분의 관점을 여기에 포함시키고 싶습니다! 변경 사항을 수정해야 하는 경우에는 로컬 저장소가 필요한 이유를 갑작스럽게 이해하게 될 것입니다. 팀원들이 다음에 어떤 조치를 취해야 하는지에 대해 설명 할 수 있습니다. 좋은 소식은 여전히 수정 가능하다는 점입니다. 해당 요청의 댓글 섹션을 확인하여 추가 정보가 요청되는지 확인하세요.

    그렇지 않으면 여러분의 요청이 승인되고 병합될 것입니다. 팀에 오신 것을 환영합니다. 이제 공식적으로 기여자가 되었습니다! Contributor Guide 하단의 All Contributors 목록에 여러분의 이름이 나타나는 것을 확인하세요. 이 과정은 몇 일 내에 완료될 것입니다.

Author: Krista Burdine

Contributors: Ezequiel Bruni, Steven Spencer