[깃허브] 이슈 이용한 협업 과정

채린·2023년 8월 24일

1) 이슈 생성→브랜치생성→개발or수정→풀리퀘→머지 순으로 진행
2) 이슈는 대체로 api기준으로 생성, 또는 특정 오류
3) 항상 작업 전 레포와 상태를 맞춰 충돌을 방지


  1. 이슈를 만든다

    이슈템플릿 형식에 맞게 제목, 내용 적고 왼쪽에서 label 고르기

  2. 해당 브렌치를 만든다
    브랜치명: [type]/#이슈번호 (ex feature/#21)

  3. 터미널가서 친다 → 브랜치 변경됨

git fetch origin
git checkout feat/#1
  1. 개발한다

  2. 내가 만든 이슈를 처리했다면 풀리퀘스트
    작업한 브랜치 → develop(default)
    제목ex feat: 로그인 api

  3. 확인 후 merge (conflict없을때)

  4. 머지했으면 branch를 지운다





템플릿

.github폴더에 저장해두면 자동 적용

  • 풀리퀘 템플릿

    	```
    	## Solved Issue
    
    	close #
    
    	<br>
    
    	## Motivation
    
    	-
    
    	<br>
    
    	## Key Changes
    
    	-
    
    	<br>
    
    	## Result
    
    	요청 및 응답 캡처 사진 및 JSON 텍스트
    
    	```
  • 이슈 템플릿

    ---
    name: Feature request
    about: Suggest an idea for this project
    title: ''
    labels: ''
    assignees: ''
    
    ---
    
    ---
    name: ISSUE TEMPLATE
    about: Describe this issue template's purpose here.
    title: 'feat:'
    labels: enhancement
    assignees: ''
    
    ---
    
    **Feature Request**
    기능 설명 : 
    
    **To-Do List**
    - [ ]
  • 커밋

    Commit convention


    기능은 가능한 작은 단위로 쪼개어 커밋합니다

    💡 **[type] description**

    [feat] 새로운 기능을 추가할 경우

    [fix] 버그를 고친 경우

    [refactor] 코드 리팩토링

    [comment] 필요한 주석 추가 및 변경

    [docs] 문서를 수정한 경우

    [test] 테스트 코드를 작성한 경우 작성

    [build] 빌드 관련 파일 수정 / 모듈 설치 또는 삭제에 대한 커밋

    [chore] 그 외 자잘한 수정에 대한 커밋

    ex) [feat] 부스 목록 조회

    [fix] 부스 목록 조회 실패 응답 수정



(추가)
requirements.txt를 작성하면 편리

pip freeze > requirements.txt

업로드 후

pip install -r requirements.txt

0개의 댓글