코드 스타일은 PEP8을 기본으로 채택합니다.
린팅과 포맷팅에는 다음 도구를 사용합니다:
yapf와 isort의 스타일 설정은 setup.cfg에서 확인할 수 있습니다.
pre-commit hook을 사용하여 커밋할 때마다 flake8, yapf, seed-isort-config, isort, trailing whitespaces를 자동으로 검사하고 포맷팅하며,
end-of-files를 수정하고 requirements.txt를 자동으로 정렬합니다.
pre-commit hook 설정은 .pre-commit-config에 저장되어 있습니다.
저장소를 클론한 후에는 pre-commit hook을 설치하고 초기화해야 합니다.
pip install -r requirements-test.txt저장소 루트 디렉터리에서:
pre-commit install이후에는 커밋할 때마다 코드 린팅과 포맷팅이 자동으로 적용됩니다.
모든 파일에 대해 pre-commit 검사를 실행하고 싶다면 다음을 실행하세요:
pre-commit run --all-files