Skip to content

Home

Jump to bottom
srlee056 edited this page Nov 5, 2023 · 7 revisions

1. 패키지 설치

pull으로 main 진행상황 모두 받아오고, requirements.txt 확인

  • (가상환경 생성하지 않았을 경우) shell 실행후 가상환경 생성
python -m venv venv
  • 가상환경 활성화
source venv/bin/activate
  • 패키지 다운로드
pip install -r requirements.txt
  • 필요 패키지를 다운받았을 경우 requirements.txt 업데이트
pip freeze > requirements.txt

2. git commit 컨벤션(규칙)

Commit message : 제목(필수), 본문, 꼬리말로 구성

<type>: <subject>

<body>

<footer>

Type

  • feat : 새로운 기능 추가, 기존의 기능을 요구 사항에 맞추어 수정
  • fix : 기능에 대한 버그 수정
  • build : 빌드 관련 수정
  • chore : 패키지 매니저 수정, 그 외 기타 수정
  • ci : CI 관련 설정 수정
  • docs : 문서(주석) 수정
  • style : 코드 스타일, 포맷팅에 대한 수정
  • refactor : 기능의 변화가 아닌 코드 리팩터링 ex) 변수 이름 변경
  • test : 테스트 코드 추가/수정
  • release : 버전 릴리즈

Subject

Type 과 함께 헤더를 구성합니다. 예를들어, 로그인 API 를 추가했다면 다음과 같이 구성할 수 있습니다.

ex) feat: Add login api

Body

헤더로 표현이 가능하다면 생략이 가능합니다. 아닌 경우에는 자세한 내용을 함께 적어 본문을 구성합니다.

Footer

issue에 대한 commit을 #{issue number} 형태로 적어 표현합니다. (#1) close #1 처럼 close 를 통해 해당 이슈를 닫는 방법도 있습니다.

3. PR (Pull Request) 규칙

PR은 최대한 작은 단위로 쪼개서 작성하기

Base가 될 issue를 생성하고 그와 관련된 sub issue들을 만들어서 작업하세요.

  • Main issue : API에서 데이터 받아오기
    • Sub issue 1 : API 키 발급
    • Sub issue 2 : raw data 받아오기
    • Sub issue 3 : 테이터 모델 형태에 맞게 저장하기

참고 링크

Clone this wiki locally