그래서... 어떻게 저장소에 기여하나요?

요약

1. 저장소를 자신의 계정으로 포크하기

2. 자신의 복사본에서 작업하고 콘텐츠 작성하기

3. 로컬에서 빌드하기

$ bash tools/build.sh
Configuration file: /home/jayleekr/00_Projects/08_ADAS_main/_config.yml
          Cleaner: Removing /home/jayleekr/00_Projects/08_ADAS_main/_site...
          Cleaner: Nothing to do for /home/jayleekr/00_Projects/08_ADAS_main/.jekyll-metadata.
          Cleaner: Nothing to do for /home/jayleekr/00_Projects/08_ADAS_main/.jekyll-cache.
          Cleaner: Nothing to do for .sass-cache.
$ cd /home/jayleekr/00_Projects/08_ADAS_main/.container
[INFO] Succeed! 5 category-pages created.
[INFO] Succeed! 6 tag-pages created.

4. 로컬에서 테스트하기

$ bash tools/test.sh
Configuration file: /home/jayleekr/00_Projects/08_ADAS_main/_config.yml
Configuration file: /home/jayleekr/00_Projects/08_ADAS_main/_config.yml
            Source: /home/jayleekr/00_Projects/08_ADAS_main
       Destination: /home/jayleekr/00_Projects/08_ADAS_main/_site
 Incremental build: disabled. Enable with --incremental
      Generating... 
                    done in 2.183 seconds.
 Auto-regeneration: enabled for '/home/jayleekr/00_Projects/08_ADAS_main'
    Server address: http://127.0.0.1:4000/
  Server running... press ctrl-c to stop.

5. 어떻게 보이는지 확인하기

브라우저를 열고 http://127.0.0.1:4000/로 이동하세요 - 모든 것이 잘 보이는지 확인하세요!

6. 변경사항 커밋하고 푸시하기

$ git add .
$ git commit -m "Add my awesome contribution"
$ git push origin main

7. Pull Request 생성하기

원본 저장소로 돌아가서 포크한 저장소에서 pull request를 생성하세요. 추가하거나 변경한 내용에 대한 멋진 설명을 작성하세요!

자세한 설명 (더 알고 싶은 분들을 위해)

안녕하세요! 멋진 오픈소스 프로젝트를 발견하고 기여하고 싶으신가요? 훌륭해요! 아무것도 망가뜨리지 않고 실제로 기여하는 방법을 단계별로 알려드리겠습니다 (저도 겪어봤거든요 😅).

왜 Clone이 아니라 Fork를 할까요?

왜 저장소를 직접 clone하지 않는지 궁금하실 수 있습니다. 음, 이미 메인테이너가 아닌 이상, 원본 저장소에 대한 쓰기 권한이 없을 겁니다. 포크는 마음껏 수정할 수 있는 자신만의 복사본을 만들어줍니다.

신성한 빌드-테스트-커밋 사이클

제가 어렵게 배운 한 가지: 푸시하기 전에 항상 로컬에서 빌드하고 테스트하세요. 이 단계를 잊어서 빌드를 망가뜨리는 pull request를 얼마나 많이 봤는지 모릅니다. 그런 사람이 되지 마세요!

빌드 프로세스는 몇 가지 중요한 작업을 수행합니다:

• 카테고리와 태그 페이지를 자동으로 생성
• 마크다운 문법 검증
• 이미지와 에셋 최적화
• 모든 링크가 작동하는지 확인

현장에서 배운 프로 팁

1. 설명적인 커밋 메시지 작성하기: “Fix stuff”는 도움이 안 됩니다. “Fix broken link in Docker tutorial”이 훨씬 좋습니다.

2. 포크를 최신 상태로 유지하기: 새 작업을 시작하기 전에 항상 업스트림 저장소와 동기화하세요:

   $ git remote add upstream https://github.com/original-owner/repo-name.git
   $ git fetch upstream
   $ git merge upstream/main

3. 다양한 화면 크기에서 테스트하기: 여러분의 기여는 데스크톱과 모바일 모두에서 잘 보여야 합니다.

4. 프로젝트 스타일 따르기: 기존 콘텐츠를 보고 톤과 형식을 맞추려고 노력하세요.

흔한 실수들

• 이미지 경로: 이미지가 올바른 디렉토리에 있고 경로가 정확한지 확인하세요
• Front matter: Jekyll은 포스트 상단의 YAML front matter에 대해 까다롭습니다
• 빌드 의존성: 필요한 모든 gem이 설치되어 있는지 확인하세요

좋은 기여란 무엇인가요?

메인테이너들은 다음과 같은 기여를 좋아합니다:

• 실제 문제를 해결하거나 진정한 가치를 추가하는 것
• 기존 규칙을 따르는 것
• 적절한 문서를 포함하는 것
• 아무것도 망가뜨리지 않는 것
• 로컬에서 테스트된 것

기억하세요, 오픈소스는 협업과 함께 더 나은 것을 만드는 것입니다. 작게 시작하는 것을 두려워하지 마세요 - 오타를 수정하는 것도 가치 있는 기여입니다!

즐거운 기여 되세요! 🚀