이 프로젝트는 초보자가 처음으로 오픈소스에 기여할 수 있도록 쉽게 안내하는 것을 목표로 합니다. 첫 번째 기여를 하고 싶다면, 아래의 설명을 따라주세요.
만약 명령어 인터페이스에 익숙하지 않다면, 여기에서 GUI 도구 튜토리얼을 참고하세요..
만약, git이 설치되어있지 않다면 설치하세요.
이 저장소 페이지의 상단에 있는 Fork 버튼을 클릭해서 저장소를 포크하세요. 그러면 본인의 깃허브 계정에 이 저장소의 복사본이 생성됩니다.
이제 fork한 저장소를 자신의 기기에 클론하세요. 깃허브 계정의 fork한 저장소에 들어가서, Code 버튼을 클릭하고, 클립보드로 url 복사 아이콘을 클릭합니다.
터미널을 열고 다음 git 명령을 실행합니다:
git clone "방금 복사한 URL"
위에 (따옴표를 제외한) "방금 복사한 URL"은 이 저장소의 URL입니다. URL은 이전 단계에서 찾을 수 있습니다.
예시:
git clone git@github.com:this-is-you/first-contributions.git
this-is-you
에 해당하는 부분을 본인의 깃허브 계정명으로 바꾸어주세요. 이 명령어는 깃허브의 first-contributions 저장소를 자신의 컴퓨터로 복사합니다.
(아직 저장소 디렉토리가 아니라면) 아래의 명령어를 입력해서 조금 전에 컴퓨터에 복사한 저장소 디렉토리로 이동합니다.
cd first-contributions
그리고 git switch
명령어를 입력해서 브랜치를 생성합니다.
git switch -c your-new-branch-name
예시:
git switch -c add-alonzo-church
이제 텍스트 편집기에서 Contributors.md
파일을 열고 본인의 이름을 아래와 같이 추가해주세요. 파일의 시작 부분이나 마지막 부분에 추가해서는 안됩니다. 중간 부분의 마음에 드는 곳에 추가하면 됩니다. 그리고 파일을 저장하세요.
프로젝트 디렉토리로 이동해서 git status
명령어를 실행하면 변경사항이 존재하는 것을 볼 수 있습니다.
변경사항을 git add
명령어를 사용해서 조금 전에 생성한 브랜치에 추가합니다.
git add Contributors.md
이제 git commit
명령어를 사용해서 변경사항을 커밋합니다.
git commit -m "Add your-name to Contributors list"
your-name
을 본인 이름으로 변경하세요.
git push
명령어로 변경사항을 푸시합니다.
git push -u origin your-branch-name
your-branch-name
부분을 조금 전에 생성한 브랜치 이름으로 변경하세요.
푸시하는 중에 에러가 발생했다면, 여기를 클릭하세요:
-
remote: Support for password authentication was removed on August 13, 2021. Please use a personal access token instead. remote: Please see https://github.blog/2020-12-15-token-authentication-requirements-for-git-operations/ for more information. fatal: Authentication failed for 'https://github.com//first-contributions.git/'
깃허브 튜토리얼로 이동해서 본인의 계정에 SSH key 생성 및 설정에 대한 정보를 얻을 수 있습니다.
이제 본인의 깃허브 저장소로 이동하면 Compare & pull request
버튼을 볼 수 있습니다. 버튼을 클릭하세요.
이제 풀 요청(Pull Request)을 제출합니다.
이제 여러분의 변경사항을 담당자가 확인한 후에 main 브랜치에 병합 하게 되면 알림 메일을 받을 수 있습니다.
축하합니다! 앞으로 기여자로서 자주 사용하게될 기본 워크플로우인 포크(fork) -> 클론(clone) -> 수정(edit) -> 풀 요청(pull request), 를 완료했습니다!
첫 기여에 대한 소식을 친구들 및 팔로워에게 웹 앱을 통해 공유해보세요.
도움이 필요하거나 질문이 있다면 저희 slack 팀에 참여할 수 있습니다. → slack 팀 참여하기
이제 다른 프로젝트에도 기여해보세요! 지금 바로 시작할 수 있는 난이도가 낮은 이슈들로 가득찬 목록이 있습니다. 웹앱의 프로젝트 목록에서 확인해보세요.
GitHub Desktop | Visual Studio 2017 | GitKraken | Visual Studio Code | Atlassian Sourcetree | IntelliJ IDEA |
This project is supported by: