feature: Django Settings 설정

JaeHyuckSa commented 1 year ago

[x] gitignore 추가
[x] gitmessage 추가
[x] CI 추가
[x] PR, Issue, bug Templates 추가
[x] pre-commit 추가
[x] Django 환경 세팅
- [x] swagger 적용
- [x] logging 적용
[x] Django App 추가

JaeHyuckSa commented 1 year ago

템플릿

Why?

어제 대화나눴던 부분 중 템플릿 적용을 위해 적용했습니다.

How?

PR 템플릿 경우 -> PR을 생성할 때 자동으로 템플릿을 적용합니다. Issue, Bug 템플릿 경우 -> 이슈와 버그 같은경우 issue를 생성 시에 템플릿을 선택하여 적용합니다.

CI(github actions)

Why?

코드 컨벤션 및 테스트 코드 통과 여부 확인을 위해 적용했습니다.

How?

branch 중 develop, main 브랜치에 PR을 생성 시 github actions툴을 이용하여 CI를 실행합니다

pre-commit

Why?

코드 컨벤션을 커밋할 때 자동으로 맞추기위해 사용했습니다.

How?

poetry install -> pre-commit 패키지 설치 poetry run pre-commit install -> pre-commit.yaml 설정파일을 적용시킴 git add -> 깃 스테이징에 올립니다. git commit -> 커밋을 할 때 포맷터 프로세스를 실행시키고 커밋을 작성합니다.

만약 Fail이 뜬다면 변경사항이 스테이징에 올라오지 않았다는 것임으로 git add 후 git commit을 다시 실행하시면 됩니다.

gitmessage

Why?

vscode를 이용한 커밋 작성도 괜찮지만 body, footer를 상세히 적을 필요가 있어 적용했습니다.

How?

git config --local commit.template ~/.gitmessage -> 명령어를 터미널에 작성해주시면 됩니다.

자료

아래는 참고했던 자료입니다.

JaeHyuckSa commented 1 year ago

poetry 가상환경 설정방법은 아래와 같이 잘 작성되어있는 블로그가 있어 링크 남깁니다!

https://blog.bespinglobal.com/post/python-%ED%8C%A8%ED%82%A4%EC%A7%80-%EA%B4%80%EB%A6%AC%EB%A5%BC-%EC%9C%84%ED%95%9C-poetry%EA%B0%80%EC%83%81%ED%99%98%EA%B2%BD%EA%B9%8C%EC%A7%80/

Django-Wanted-Internship-3-Team / repo1_feed-service