AutoFormatting
black : 파이썬 포맷팅
isort : import를 정리
make format
# Makefile
format:
black .
isort .
윈도우는 make 명령어를 실행하기 위해 설치가 필요함
make 설치 링크 : http://gnuwin32.sourceforge.net/packages/make.htm
설치하고서 C 드라이브 내 GnuWin32가 설치된 폴더의 bin 폴더의 위치를 시스템 환경 변수로 등록해주면 된다.
Linting & Type Hinting
어떤 부분이 유지보수성이 떨어지니까 고쳤으면 좋겠다는 가이드라인을 제공
Linting : pyling, flake8
Hinting : 타입 지정 mypy
Doctring
Google Style
Numpy Style
Pre-commit
pre-commit
Github action
.github/workflow깃허브에서 서버를 빌려줘서 precommit이 되는지 remote site에서 돌려주는 것
.github/workflows/
멘토님 참고 레포:
https://github.com/Team-CLUE/headfirst_design_pattern/tree/main/.github
튜토리얼 사이트:
https://docs.github.com/en/actions