diff --git a/README.md b/README.md index 868018f..3448c27 100644 --- a/README.md +++ b/README.md @@ -26,8 +26,28 @@ python manage.py runserver 한번 실행하면 자동으로 secret_key를 저장하는 .env파일 생성 > SECRET_KEY는 소스코드, 깃허브에 올리지 말 것! +### branch rule +master 브런치로 바로 push는 불가능 + +작업 시, 새로운 브런치 추가 +```bash +git branch new_branch +git checkout new_branch +``` + +vscode git 기능 사용 or +```bash +git add file +git commit -m "커밋 메세지" +git push --set-upstream origin new_branch +``` + +이후 github 페이지에서 PR 생성 후 테스트 통과 시, merge + + + ## DEPLOY -git action을 통해 master 브런치에 push or PR merge 시, 자동으로 배포 +`git action`을 통해 `master` 브런치에 push or PR merge 시, 자동으로 배포 다만 웬만해서 PR을 통해 test후 배포하는 것을 권장 @@ -41,10 +61,22 @@ docker-compose up --build -d ## FEAT 작성중... ### Swagger - +* /swagger : API test +* /redoc : API 문서 ### API +각 API endpoint마다 django-rest-api 테스트 form 구현(다만 swagger로 테스트하는 걸 추천) + +### AUTH +`student_id`를 통해 로그인하도록 custom backend 구현 + +다만 계정 생성, 로그인 API 수정하는 걸 추천 +> TODO : `user.view.py` 수정 +### Test +workflow에 push시, test 실행되도록 구현 +다만 아직 테스트 코드 구현 X +> TODO : 각 모듈별 `tests.py` 내 테스트 코드 작성 ## EDITOR SETTING (code style) vscode 사용 권장