InfoGrab DocsInfoGrab Docs

레슨 1

요약

이 레슨에서는 가장 작은 문제 - 한 글자 텍스트 변경 - 을 다룹니다. GitLab 개발 환경을 설정하는 방법. GitLab 코드베이스를 탐색하는 방법. GitLab 프로젝트에서 머지 리퀘스트를 만드는 방법. 이 세 가지를 학습한 후, GitLab 팀원이 라이브 코딩 데모를 진행합니다.

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

이 레슨에서는 가장 작은 문제 - 한 글자 텍스트 변경 - 을 다룹니다. 이를 위해 다음 내용을 학습합니다:

  • GitLab 개발 환경을 설정하는 방법.

  • GitLab 코드베이스를 탐색하는 방법.

  • GitLab 프로젝트에서 머지 리퀘스트를 만드는 방법.

이 세 가지를 학습한 후, GitLab 팀원이 라이브 코딩 데모를 진행합니다. 데모에서는 이러한 작은 이슈 중 하나를 완료하면서 학습한 내용을 각각 활용하므로, 여러분 스스로 이슈를 완료할 수 있게 됩니다.

라이브 코딩에서 다룰 것과 매우 유사한 이슈 목록이 “연결된 항목” 섹션 여기에 있습니다. 함께 따라올 수 있도록 지금 그 중 하나에 댓글을 달아 자신을 할당받는 것이 좋습니다.

GDK란 무엇인가요?#

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

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

GDK 사용 팁:

  • 트러블슈팅 문서: GDK 관련 문제가 발생하면 GDK 리포지터리의 트러블슈팅 문서를 참조하세요. 이 자료에는 일반적인 문제를 해결하는 데 도움이 되는 유용한 명령어와 팁이 있습니다.

  • Rails 콘솔 사용: Rails 콘솔은 로컬 GitLab 인스턴스와 상호작용하는 데 필수적인 도구입니다. gdk rails c를 실행하여 접근할 수 있으며, 기능 플래그를 활성화하거나 비활성화하고, 백엔드 작업을 수행하는 등의 작업에 사용할 수 있습니다.

  • 최신 상태 유지: gdk update를 실행하여 GDK를 정기적으로 업데이트하세요. 이 명령어는 GitLab 프로젝트의 최신 브랜치와 GDK 및 그 의존성의 최신 브랜치를 가져옵니다. GDK를 최신 상태로 유지하면 최신 버전의 GitLab으로 작업하고 최신 버그 수정 사항을 적용할 수 있습니다.

추가 도움이 필요하거나 특정 질문이 있는 경우, Discord 또는 기타 지원 채널을 통해 GitLab 커뮤니티에 문의할 수 있습니다.

GDK를 로컬에 설치하고 사용하기#

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

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

단계별 요약은 다음과 같습니다:

  • 사전 요구 사항:

16 GB RAM.

GitLab Development Kit(GDK)를 설치할 디렉터리를 선택합니다.

터미널을 열고 선택한 디렉터리로 이동합니다.

터미널에서 설치 스크립트를 다운로드하고 실행합니다:

curl "https://gitlab.com/gitlab-org/gitlab-development-kit/-/raw/main/support/install" | bash

안전을 위해 신뢰할 수 있는 소스의 스크립트만 실행하세요.

설치 과정은 약 20분 이상 소요될 수 있습니다.

  • 리포지터리 선택:

메인 GitLab 리포지터리를 클론하는 대신, 더 넓은 커뮤니티 구성원에게 권장되는 커뮤니티 포크를 사용합니다.

  • 커뮤니티 포크를 설치하기 위해 제공된 지침을 따릅니다.

  • GDK 구조:

설치 후 GDK 디렉터리가 생성됩니다.

  • GDK 디렉터리 내부에서 GitLab 프로젝트 폴더를 찾을 수 있습니다.

  • GDK로 작업하기:

GDK는 설치와 상호작용할 수 있는 다양한 명령어를 제공합니다. 이러한 명령어를 실행하려면 GDK 또는 GitLab 폴더 내부에 있어야 합니다.

  • GDK를 시작하려면 터미널에서 gdk start 명령어를 실행합니다.

  • 터미널에서 gdk help를 실행하여 사용 가능한 명령어와 옵션을 탐색할 수 있습니다.

추가 질문이나 문제가 있는 경우 문서를 참조하거나 커뮤니티 지원을 구하는 것을 기억하세요.

GitLab 코드베이스 탐색#

동영상 보기: GitLab 코드베이스 탐색 방법.

GitLab 코드베이스를 탐색하는 방법을 이해하는 것은 기여자에게 필수적입니다. 코드베이스를 탐색하고 특정 파일을 찾는 것은 어려울 수 있지만, 변경 사항을 적용하고 이슈를 효과적으로 해결하기 위해 중요합니다. 여기서는 파일을 찾고 GitLab에서 어디에 렌더링되는지 확인하는 단계별 과정을 살펴봅니다.

작업할 파일을 이미 알고 있고 어디에 렌더링되는지 찾고 싶은 경우:

  • 파일의 목적을 이해하기 위해 단서를 수집하는 것부터 시작합니다. 컨텍스트를 나타낼 수 있는 키워드나 특정 콘텐츠와 같이 파일 내부의 관련 정보를 찾아보세요.

  • 파일 경로(또는 폴더 구조)를 검토하여 파일이 렌더링될 수 있는 위치에 대한 인사이트를 얻을 수도 있습니다. GitLab의 많은 라우팅이 폴더 구조와 매우 유사합니다.

  • 이 컴포넌트가 사용되는 기능(또는 기능 중 하나)을 파악할 수 있다면, GitLab 사용자 문서를 활용하여 해당 기능 페이지로 이동하는 방법을 찾을 수 있습니다.

  • 컴포넌트 계층 구조를 따라가면서, 파일 이름으로 전역 검색을 수행하여 컴포넌트를 렌더링하는 상위 컴포넌트를 찾습니다. 컴포넌트 계층 구조를 계속 따라가면서 GitLab 사용자 문서에서 인식하거나 검색할 수 있는 기능으로 거슬러 올라갑니다.

  • GitLens와 같은 확장 프로그램을 사용하여 git blame을 활용하면 이 파일이 변경된 최근 머지 리퀘스트를 찾을 수 있습니다. 대부분의 머지 리퀘스트에는 따를 수 있는 “검증 방법” 섹션이 있으며, 없다면 검증 단계가 있는 이전 변경 사항을 찾을 때까지 계속 이전 변경 사항을 찾아보세요.

수정해야 할 페이지를 알고 있고 파일 경로를 찾고 싶은 경우, 다음과 같은 방법을 시도할 수 있습니다:

  • 번역 변수를 검색할 수 있도록 변수를 포함하지 않고 고유한 콘텐츠를 찾아보세요.

  • Vue Dev Tools를 사용하여 컴포넌트 이름을 찾아보세요.

  • 컴포넌트 HTML에서 data-testid, id 또는 고유해 보이는 CSS 클래스와 같은 고유 식별자를 찾아 코드베이스 전역에서 해당 식별자 문자열을 검색해보세요.

좋은 머지 리퀘스트 작성하기#

동영상 보기: 좋은 머지 리퀘스트 작성 방법.

머지 리퀘스트를 작성할 때 알아야 할 중요한 사항들이 있습니다:

  • 여러분의 머지 리퀘스트는 GitLab 프로젝트 문서의 영구적인 부분이 됩니다. 일부 코드가 현재 방식으로 작동하는 이유와 대안 솔루션을 사용하지 않는 이유를 사람들이 이해하는 데 향후 활용될 수 있습니다.

  • 최소 2명의 다른 엔지니어가 여러분의 코드를 리뷰할 것입니다. 효율성을 위해(작성한 코드 자체와 마찬가지로) 머지 리퀘스트를 올바르게 작성하는 데 조금 더 시간을 들이는 것이 좋습니다. 그래야 다른 사람들이 더 빠르고 쉽게 읽을 수 있습니다.

  • GitLab에서 만든 머지 리퀘스트는 공개적으로 열람 가능합니다. 즉, 특히 자랑스러운 머지 리퀘스트 링크를 취업 시 포트폴리오 페이지에 추가할 수 있습니다.

  • 머지 리퀘스트는 기술 문서이므로 기술 문서 작성 스타일을 구현하려고 노력해야 합니다. 이에 대해 모른다면 Google의 기술 문서 작성 단기 과정을 강력히 추천합니다. GitLab 문서에도 기여하고 있다면 GitLab에서 제공하는 기술 문서 작성 기초 과정이 있습니다.

라이브 코딩#

동영상 보기: 레슨 1 코드 워크스루.

이제 여러분이 첫 번째 머지 리퀘스트를 완료할 차례입니다. 방금 완료한 것과 매우 유사하여 완료가 필요한 이슈 목록이 “연결된 항목” 섹션 여기에 있습니다. 기여해 주셔서 감사합니다! (남은 이슈가 없다면 Discord 또는 기타 지원 채널을 통해 알려주시면 더 많은 이슈를 찾아드리겠습니다)

레슨 1

GitLab v19.1
원문 보기
요약

이 레슨에서는 가장 작은 문제 - 한 글자 텍스트 변경 - 을 다룹니다. GitLab 개발 환경을 설정하는 방법. GitLab 코드베이스를 탐색하는 방법. GitLab 프로젝트에서 머지 리퀘스트를 만드는 방법. 이 세 가지를 학습한 후, GitLab 팀원이 라이브 코딩 데모를 진행합니다.

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

이 레슨에서는 가장 작은 문제 - 한 글자 텍스트 변경 - 을 다룹니다. 이를 위해 다음 내용을 학습합니다:

  • GitLab 개발 환경을 설정하는 방법.

  • GitLab 코드베이스를 탐색하는 방법.

  • GitLab 프로젝트에서 머지 리퀘스트를 만드는 방법.

이 세 가지를 학습한 후, GitLab 팀원이 라이브 코딩 데모를 진행합니다. 데모에서는 이러한 작은 이슈 중 하나를 완료하면서 학습한 내용을 각각 활용하므로, 여러분 스스로 이슈를 완료할 수 있게 됩니다.

라이브 코딩에서 다룰 것과 매우 유사한 이슈 목록이 “연결된 항목” 섹션 여기에 있습니다. 함께 따라올 수 있도록 지금 그 중 하나에 댓글을 달아 자신을 할당받는 것이 좋습니다.

GDK란 무엇인가요?#

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

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

GDK 사용 팁:

  • 트러블슈팅 문서: GDK 관련 문제가 발생하면 GDK 리포지터리의 트러블슈팅 문서를 참조하세요. 이 자료에는 일반적인 문제를 해결하는 데 도움이 되는 유용한 명령어와 팁이 있습니다.

  • Rails 콘솔 사용: Rails 콘솔은 로컬 GitLab 인스턴스와 상호작용하는 데 필수적인 도구입니다. gdk rails c를 실행하여 접근할 수 있으며, 기능 플래그를 활성화하거나 비활성화하고, 백엔드 작업을 수행하는 등의 작업에 사용할 수 있습니다.

  • 최신 상태 유지: gdk update를 실행하여 GDK를 정기적으로 업데이트하세요. 이 명령어는 GitLab 프로젝트의 최신 브랜치와 GDK 및 그 의존성의 최신 브랜치를 가져옵니다. GDK를 최신 상태로 유지하면 최신 버전의 GitLab으로 작업하고 최신 버그 수정 사항을 적용할 수 있습니다.

추가 도움이 필요하거나 특정 질문이 있는 경우, Discord 또는 기타 지원 채널을 통해 GitLab 커뮤니티에 문의할 수 있습니다.

GDK를 로컬에 설치하고 사용하기#

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

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

단계별 요약은 다음과 같습니다:

  • 사전 요구 사항:

16 GB RAM.

GitLab Development Kit(GDK)를 설치할 디렉터리를 선택합니다.

터미널을 열고 선택한 디렉터리로 이동합니다.

터미널에서 설치 스크립트를 다운로드하고 실행합니다:

curl "https://gitlab.com/gitlab-org/gitlab-development-kit/-/raw/main/support/install" | bash

안전을 위해 신뢰할 수 있는 소스의 스크립트만 실행하세요.

설치 과정은 약 20분 이상 소요될 수 있습니다.

  • 리포지터리 선택:

메인 GitLab 리포지터리를 클론하는 대신, 더 넓은 커뮤니티 구성원에게 권장되는 커뮤니티 포크를 사용합니다.

  • 커뮤니티 포크를 설치하기 위해 제공된 지침을 따릅니다.

  • GDK 구조:

설치 후 GDK 디렉터리가 생성됩니다.

  • GDK 디렉터리 내부에서 GitLab 프로젝트 폴더를 찾을 수 있습니다.

  • GDK로 작업하기:

GDK는 설치와 상호작용할 수 있는 다양한 명령어를 제공합니다. 이러한 명령어를 실행하려면 GDK 또는 GitLab 폴더 내부에 있어야 합니다.

  • GDK를 시작하려면 터미널에서 gdk start 명령어를 실행합니다.

  • 터미널에서 gdk help를 실행하여 사용 가능한 명령어와 옵션을 탐색할 수 있습니다.

추가 질문이나 문제가 있는 경우 문서를 참조하거나 커뮤니티 지원을 구하는 것을 기억하세요.

GitLab 코드베이스 탐색#

동영상 보기: GitLab 코드베이스 탐색 방법.

GitLab 코드베이스를 탐색하는 방법을 이해하는 것은 기여자에게 필수적입니다. 코드베이스를 탐색하고 특정 파일을 찾는 것은 어려울 수 있지만, 변경 사항을 적용하고 이슈를 효과적으로 해결하기 위해 중요합니다. 여기서는 파일을 찾고 GitLab에서 어디에 렌더링되는지 확인하는 단계별 과정을 살펴봅니다.

작업할 파일을 이미 알고 있고 어디에 렌더링되는지 찾고 싶은 경우:

  • 파일의 목적을 이해하기 위해 단서를 수집하는 것부터 시작합니다. 컨텍스트를 나타낼 수 있는 키워드나 특정 콘텐츠와 같이 파일 내부의 관련 정보를 찾아보세요.

  • 파일 경로(또는 폴더 구조)를 검토하여 파일이 렌더링될 수 있는 위치에 대한 인사이트를 얻을 수도 있습니다. GitLab의 많은 라우팅이 폴더 구조와 매우 유사합니다.

  • 이 컴포넌트가 사용되는 기능(또는 기능 중 하나)을 파악할 수 있다면, GitLab 사용자 문서를 활용하여 해당 기능 페이지로 이동하는 방법을 찾을 수 있습니다.

  • 컴포넌트 계층 구조를 따라가면서, 파일 이름으로 전역 검색을 수행하여 컴포넌트를 렌더링하는 상위 컴포넌트를 찾습니다. 컴포넌트 계층 구조를 계속 따라가면서 GitLab 사용자 문서에서 인식하거나 검색할 수 있는 기능으로 거슬러 올라갑니다.

  • GitLens와 같은 확장 프로그램을 사용하여 git blame을 활용하면 이 파일이 변경된 최근 머지 리퀘스트를 찾을 수 있습니다. 대부분의 머지 리퀘스트에는 따를 수 있는 “검증 방법” 섹션이 있으며, 없다면 검증 단계가 있는 이전 변경 사항을 찾을 때까지 계속 이전 변경 사항을 찾아보세요.

수정해야 할 페이지를 알고 있고 파일 경로를 찾고 싶은 경우, 다음과 같은 방법을 시도할 수 있습니다:

  • 번역 변수를 검색할 수 있도록 변수를 포함하지 않고 고유한 콘텐츠를 찾아보세요.

  • Vue Dev Tools를 사용하여 컴포넌트 이름을 찾아보세요.

  • 컴포넌트 HTML에서 data-testid, id 또는 고유해 보이는 CSS 클래스와 같은 고유 식별자를 찾아 코드베이스 전역에서 해당 식별자 문자열을 검색해보세요.

좋은 머지 리퀘스트 작성하기#

동영상 보기: 좋은 머지 리퀘스트 작성 방법.

머지 리퀘스트를 작성할 때 알아야 할 중요한 사항들이 있습니다:

  • 여러분의 머지 리퀘스트는 GitLab 프로젝트 문서의 영구적인 부분이 됩니다. 일부 코드가 현재 방식으로 작동하는 이유와 대안 솔루션을 사용하지 않는 이유를 사람들이 이해하는 데 향후 활용될 수 있습니다.

  • 최소 2명의 다른 엔지니어가 여러분의 코드를 리뷰할 것입니다. 효율성을 위해(작성한 코드 자체와 마찬가지로) 머지 리퀘스트를 올바르게 작성하는 데 조금 더 시간을 들이는 것이 좋습니다. 그래야 다른 사람들이 더 빠르고 쉽게 읽을 수 있습니다.

  • GitLab에서 만든 머지 리퀘스트는 공개적으로 열람 가능합니다. 즉, 특히 자랑스러운 머지 리퀘스트 링크를 취업 시 포트폴리오 페이지에 추가할 수 있습니다.

  • 머지 리퀘스트는 기술 문서이므로 기술 문서 작성 스타일을 구현하려고 노력해야 합니다. 이에 대해 모른다면 Google의 기술 문서 작성 단기 과정을 강력히 추천합니다. GitLab 문서에도 기여하고 있다면 GitLab에서 제공하는 기술 문서 작성 기초 과정이 있습니다.

라이브 코딩#

동영상 보기: 레슨 1 코드 워크스루.

이제 여러분이 첫 번째 머지 리퀘스트를 완료할 차례입니다. 방금 완료한 것과 매우 유사하여 완료가 필요한 이슈 목록이 “연결된 항목” 섹션 여기에 있습니다. 기여해 주셔서 감사합니다! (남은 이슈가 없다면 Discord 또는 기타 지원 채널을 통해 알려주시면 더 많은 이슈를 찾아드리겠습니다)