Skip to content

Latest commit

 

History

History
128 lines (109 loc) · 4.12 KB

04. 깃허브 프로젝트 생성 및 관리.md

File metadata and controls

128 lines (109 loc) · 4.12 KB

4-1. 깃허브 프로젝트 생성

1.GitHub 리포지토리 생성

  1. GitHub에 로그인 후 오른쪽 상단의 + -> New repository 선택
  2. 필수 입력 사항을 입력합니다:
    • Repository name: 저장소 이름입니다.
    • Visibility: 공개 여부입니다.
  3. 옵션을 선택합니다:
    • README 파일을 추가합니다.
    • gitignore 템플릿을 선택합니다. (예: Python 과제인 경우 Python을 선택합니다.)
  4. Create repository를 클릭합니다.

2.파일 추가하기

  1. 웹에서 바로 파일 추가 :
    • 리포지토리 안에서 Add file -> Upload files -> 파일 드래그 앤 드롭.
  2. 로컬에서 작업 후 업로드 :
    • Git 명렁어로 프로젝트 업로드 : git init git add . git commit -m "First commit" git branch -M main git remote add origin <리포지토리 URL> git push -u origin main

3.협업 관리 (팀 과제일 경우)

  1. 리포지토리에서 Settings -> Collaborators 클릭.
  2. 팀원 GitHub 아이디로 초대.

4.작업 관리하기

  1. Issues (이슈 관리)
    • 이슈 생성 : 이슈 탭에서 "New lssue" 버튼을 클릭하여 해야 할 작업, 버그, 개선 사항 등을 기록.
    • 기여 지침 작성 :
      • CONTRIBUTING.md 파일을 생성하여 프로젝트에 기여하는 방법을 명시. 예 :

기여 지침

  1. 이슈를 확인하고 적합한 작업을 선택하세요.

  2. 작업 전 Assignee에 자신을 지정하여 충돌 방지.

  3. 작업 완료 후 Pull Request를 생성하세요.

    • 이슈 템플릿 작성 : 일관성을 위해 템플릿 사용.
      • 리포지토리 루트에 .github/ISSUE_TEMPLATE 폴더 생성.
      • 예 : bug_report.md 와 같은 파일 작성

name: Bug Report about: Report a bug to help us improve title: "[BUG] " labels: bug assignees: ''

문제 설명 어떤 문제가 발생했나요?

재현 방법

  1. ~를 실행한다.
  2. ~를 클릭한다.
  3. 에러가 발생한다.

기대 결과 어떤 결과를 기대했나요?

스크린샷 문제를 보여주는 스크린샷을 추가하세요.

  1. Projects(칸반 보드로 작업 관리)

    • 칸반 보드 생성 : Projects 탭에서 새 프로젝트를 생성하고, 보드 형식 선택.
    • 컬럼 정의 :
      • 기본적으로 To Do, In Progress, Done 컬럼을 생성.
    • 카드 추가 :
      • 이슈를 보드에 드래그하여 관리.
      • 상태 변화에 따라 To Do -> In Progress -> Done 으로 이동.

  2. Pull Requests (PR로 코드 병합 검토)

    • PR 생성 :
    • 작업이 완료되면 "New Pull Request" 버튼으로 클릭하여 작업 내용을 병합 요청.
    • 리뷰 요청 :
    • 팀원을 리뷰어로 지정하여 코드 리뷰 진행.
    • 검토 체크리스트 :
    • 코드 스타일 준수 여부 확인.
    • 기능 정상 동작 여부 확인.
    • 병합 :
    • 리뷰 완료 후 "Merga Pull Request" 버튼 클릭.

5.과제 제출

  1. 리포지토리의 링크를 복사하여 제출.
  2. 필요하면 README.md 에 설명 추가 :
    • 과제 주제
    • 실행 방법
    • 주요 내용 요약

4-2. 깃허브 프로젝트 관리

추가 기능 설명

  1. GitHub Actions

    • 자동화된 워크플로 설정 : 빌드, 테스트, 배포 등 작업을 자동화.
    • 기본적으로 .github/workflows 폴더에 워크플로 파일 (ym1) 생성.
    • 예제 (Python 테스트 자동화) : name: Python Tests on: [push] jobs: test: runs-on: ubuntu-latest steps:
    • uses: actions/checkout@v3
    • name: Set up Python uses: actions/setup-python@v4 with: python-version: '3.8'
    • name: Install dependencies run: | pip install -r requirements.txt
    • name: Run tests run: | pytest

  2. Wiki

    • 프로젝트 설명, 문서화, 개발 가이드를 정리하는 공간.
    • Wiki 탭에서 "Create your first page" 버튼 클릭 후 문서를 작성.

  3. Discussions

    • 팀원 간의 의견 공유 및 협업.
    • Discussions 탭 활성화 :
      • Settings -> Features -> Discussions 활성화.
    • 사용 예시 :
      • 아이디어 브레인스토밍.
      • 기능 제안 및 피드백.