레슨 1

동영상 보기: 레슨 1 소개.

이 레슨에서는 가장 작은 문제 - 한 글자만 변경하는 것에 대처합니다. 이를 위해 우리는 배워야 할 것이 있습니다.

  • GitLab 개발 환경을 설정하는 방법
  • GitLab 코드 베이스를 탐색하는 방법
  • GitLab 프로젝트에서 병합 요청을 생성하는 방법

이 3가지를 배운 후에 GitLab 팀원이 라이브 코딩 데모를 진행할 것입니다. 데모에서 그들은 배운 것들을 사용하여 이러한 작은 문제 중 하나를 완료함으로써 여러분이 직접 문제 해결을 완료할 수 있도록 도와줄 것입니다.

우리가 라이브 코딩을 할 작은 문제와 매우 유사한 문제들의 목록이 여기 “연결된 항목” 섹션에 있습니다. 여러분이 따라 갈 수 있도록 지금 이 중 하나에 의견을 남겨서 여러분을 할당받을 수 있도록 하는 것이 도움이 될 것입니다.

GDK란 무엇인가요?

동영상 보기: GDK란 무엇인가요?

GDK(GitLab Development Kit)는 개발자가 자신의 컴퓨터에서 GitLab을 실행하고 테스트할 수 있도록 하는 GitLab의 로컬 인스턴스입니다. Frontend 전용 애플리케이션과는 달리, GDK는 백엔드 서비스, API 및 로컬 데이터베이스를 포함한 전체 GitLab 애플리케이션을 실행합니다. 이를 통해 개발자는 변경 사항을 만들고 실시간으로 테스트하고 수정 사항을 유효성 검사할 수 있습니다.

GDK 사용 팁:

  • 문제 해결 문서: GDK에서 문제를 만날 때는 GDK 저장소의 문제 해결 문서를 참조하세요. 이러한 자료는 일반적인 문제를 해결하는 데 도움이 되는 유용한 명령어와 팁을 제공합니다.
  • Rails 콘솔 사용: Rails 콘솔은 로컬 GitLab 인스턴스와 상호 작용하기 위한 필수 도구입니다. gdk rails c를 실행하여 애플리케이션의 설정 변경, 기능 플래그 활성화 또는 비활성화, 백엔드 작업 등을 수행할 수 있습니다.
  • 업데이트 유지: GDK를 정기적으로 업데이트하여 gdk update를 실행하세요. 이 명령은 GitLab 프로젝트의 최신 브랜치와 GDK 및 종속성의 최신 브랜치를 가져옵니다. GDK를 최신 상태로 유지하면 최신 버전의 GitLab을 사용하고 최신 버그 수정을 보장할 수 있습니다.

더 자세한 지원이 필요하거나 구체적인 질문이 있으면 Discord다른 이용 가능한 지원 채널을 통해 GitLab 커뮤니티에 문의할 수 있습니다.

로컬로 GDK 설치 및 사용

동영상 보기: GDK 설치하기.

최신 설치 지침은 GitLab Development Kit 문서를 참조하세요.

다음은 단계별 요약입니다:

  1. 사전 요구 사항:
    • 16GB RAM. 더 적은 용량이라면 Gitpod 사용을 고려하세요.
    • 컴퓨터에 Git이 설치되어 있는지 확인하세요.
    • Visual Studio Code와 같은 코드 편집기를 설치하세요.
    • GitLab.com에서 계정을 만들거나 로그인하고 커뮤니티 멤버 그룹에 가입하세요.
  2. 설치:
    • GitLab Development Kit (GDK)를 설치할 디렉토리를 선택하세요.
    • 터미널을 열고 선택한 디렉토리로 이동하세요.
    • 터미널에서 설치 스크립트를 다운로드하고 실행하세요:

      curl "https://gitlab.com/gitlab-org/gitlab-development-kit/-/raw/main/support/install" | bash
      
    • 안전한 소스에서만 스크립트를 실행하세요.
    • 설치 과정에는 약 20분 이상이 소요될 수 있습니다.
  3. 저장소 선택:
    • 기본 GitLab 저장소를 복제하는 대신, 보다 넓은 커뮤니티 구성원을 위해 추천되는 커뮤니티 포크를 사용하세요.
    • 커뮤니티 포크를 설치하도록 안내되는 지침에 따르세요.
  4. GDK 구조:
    • 설치 후에 GDK 디렉토리가 생성됩니다.
    • GDK 디렉토리 내에서 GitLab 프로젝트 폴더를 찾을 수 있습니다.
  5. GDK 사용:
    • GDK는 설치된 애플리케이션과 상호 작용할 수 있는 많은 명령어를 제공합니다. 이러한 명령어를 실행하려면 GDK나 GitLab 폴더 내에 있어야 합니다.
    • 터미널에서 gdk start 명령을 실행하여 GDK를 시작하세요.
    • gdk help을 터미널에서 실행하여 사용 가능한 명령어 및 옵션을 확인할 수 있습니다.

추가 질문이나 문제가 있으면 문서를 참조하거나 커뮤니티 지원을 찾아보세요.

Gitpod를 로컬로 실행하는 대신 사용하기

Gitpod는 개인 컴퓨터에서 실행하는 대신 Gitpod 서버에서 특히 GitLab 개발 키트(GDK)를 실행할 수 있는 가상 머신을 실행하는 서비스입니다. 여기에서는 코드를 편집하고 GDK를 실제로 사용할 수 있는 웹 기반 통합 개발 환경(IDE)를 제공합니다. Gitpod는 GDK 환경을 빠르게 구축하여 실행할 수 있으며, GDK를 로컬로 설치하지 않고도 작은 병합 요청을 만들거나 자원이 충분하지 않은 컴퓨터에서 GDK를 실행하는 데 유용합니다.

Gitpod 사용 방법:

  1. GitLab 커뮤니티 포크 웹사이트로 이동하여 편집을 선택한 다음 Gitpod을 선택합니다.
  2. 편집(Visual Studio Code 데스크톱 또는 브라우저) 및 컨텍스트(일반적으로 main 또는 master 브랜치)와 같은 설정을 구성합니다.
  3. 열기를 선택하여 Gitpod 워크스페이스를 생성합니다. 이 프로세스는 최대 20분이 걸릴 수 있습니다. GitLab 개발 키트(GDK)가 Gitpod 워크스페이스에 설치됩니다. 이 설치는 로컬로 전체 GDK를 다운로드하고 설치하는 것보다 빠릅니다.

워크스페이스가 생성되면 선택한 IDE가 브라우저에서 실행됩니다. 원하는 경우 데스크톱 IDE에 연결할 수도 있습니다. Gitpod를 로컬에서 사용하는 것처럼 취급하세요. 브랜치를 만들고 코드 변경을 만들어 커밋하고 커뮤니티 포크로 다시 푸시하세요.

기타 팁:

  • 워크스페이스가 시간 초과되는 것을 방지하려면 정기적으로 코드를 푸시하세요. 유휴 워크스페이스는 최종적으로 파괴됩니다.
  • 필요한 경우 Gitpod 워크스페이스 설정을 사용자 정의하여 GitLab 프론트엔드를 공개적으로 사용할 수 있도록 설정합니다.
  • 분을 모두 사용한 경우 Discord 서버의 지원팀에 문의하세요.
  • 로컬로 실행하는 것처럼 Gitpod 워크스페이스에서 gdk startgdk status와 같은 명령을 사용하여 문제를 해결합니다.

이러한 단계를 따르면 로컬 설치가 필요 없이 GitLab 개발 키트를 효율적으로 개발할 수 있습니다.

GitLab 코드베이스 탐색

GitLab 코드베이스를 탐색하는 것은 기여자에게 있어서 중요합니다. 코드베이스를 탐색하고 특정 파일을 찾는 것은 변경을 만들고 문제를 효과적으로 해결하기 위해 중요하지만 어려울 수도 있습니다. 여기에서는 GitLab에서 파일을 찾고 어디에서 렌더링되는지 찾는 단계별 프로세스를 살펴보겠습니다.

이미 사용할 파일을 알고 있고 렌더링 위치를 찾으려는 경우:

  1. 파일의 목적을 이해하기 위해 단서를 수집하여 시작하세요. 파일 자체에서 관련 정보를 찾아보세요. 즉, 해당 콘텐츠가 상황을 나타낼 수 있는 특정 키워드 또는 콘텐츠를 찾아보세요.
  2. 파일 경로(또는 폴더 구조)를 검토하여 파일이 렌더링될 수 있는 위치에 대한 통찰을 얻을 수 있습니다. GitLab의 대부분의 라우팅은 폴더 구조와 매우 유사합니다.
  3. 이 구성 요소가 사용된 기능(또는 기능 중 하나)을 찾고 나면 GitLab 사용자 문서를 활용하여 해당 기능 페이지로 이동하는 방법을 찾을 수 있습니다.
  4. 구성 요소 계층 구조를 따라가면서 부모 구성 요소를 식별하는 파일 이름을 전역으로 검색하여 해당 구성 요소를 렌더링하는 부모 구성 요소를 식별하세요. 구성 요소의 계층 구조를 계속 따라가서 인식하거나 GitLab 사용자 문서에서 검색할 수 있는 기능으로 돌아갑니다.
  5. git blame과 같은 명령을 사용하여 최근에 해당 파일이 변경된 MR을 찾을 수 있습니다. 대부분의 MR에는 해당 파일이 변경된 MR에서 따라야 하는 “유효성 검사 방법(How to validate)” 섹션이 있습니다. 이 섹션이 없는 경우 이전 변경사항을 찾아 검증 단계가 있는 MR을 찾을 때까지 찾아보세요.

수정해야 할 페이지를 알고 있는 경우 파일 경로를 찾고 싶다면 다음을 시도해보세요:

  • 변수를 포함하지 않고 고유하고 유일한 콘텐츠를 찾아서 번역 변수를 검색할 수 있도록 합니다.
  • Vue Dev Tools를 사용하여 구성 요소 이름을 찾아보세요.
  • HTML의 data-testid, id, 또는 고유하게 보이는 CSS 클래스와 같은 고유 식별자를 찾아 전역으로 코드베이스를 검색하세요.

좋은 병합 요청 작성하기

비디오 보기: 좋은 MR 작성 방법.

병합 요청을 작성할 때 중요한 사항이 몇 가지 있습니다:

  • MR은 GitLab 프로젝트의 문서의 영구적인 부분이 될 것입니다. 미래에 어떤 코드가 작동하는 방식과 대체 솔루션을 사용하지 않는 이유를 이해하는 데 도움을 줄 수 있습니다.
  • 적어도 다른 엔지니어 2명이 당신의 코드를 검토할 것입니다. 효율성을 위해(작성한 코드처럼) MR을 올바르게 만드는 데 조금 더 시간을 들이는 것이 다른 사람들이 빠르고 쉽게 읽을 수 있도록 도움이 됩니다.
  • GitLab에서 생성하는 MR은 대중에게 공개됩니다. 이는 취업 시 포트폴리오 페이지에 특히 자랑스럽다고 생각하는 MR에 링크를 추가할 수 있다는 것을 의미합니다.
  • MR은 기술 문서이므로 기술적인 글쓰기 스타일을 적용해야 합니다. 이에 대해 잘 모르신다면, 여기 Google의 기술적 글쓰기에 대한 권장하는 짧은 강좌가 있습니다. 또한 GitLab에서 문서에 기여하는 경우, GitLab에서 제공하는 기술 글쓰기 기본 과정도 있습니다.

실시간 코딩

비디오 보기: 레슨 1 코드 설명.

이제 여러분 차례입니다. 첫 번째 MR을 완료하세요. 방금 완료한 것과 매우 유사한 이슈 목록이 “링크된 항목” 섹션에 완료해야 할 목록이 있습니다 여기. 기여해 주셔서 감사합니다! (남은 것이 없다면, Discord이나 기타 지원 채널에서 알려주시면 더 찾아드리겠습니다)