서강대학교 Capstone Design I 수업을 위한 팀 WingIt의 프로젝트입니다.
Branch는 기본적으로 2개로 운영할 예정입니다.
- master (배포용 브랜치입니다)
- dev (개발용 브랜치입니다)
배포용 브랜치(master)는 최종 코드만 올라가 있는 브랜치입니다. 담당자가 PR을 통해 작업 완료된 코드를 합치는 경우를 제외하고는 건드리지 않습니다.
개발용 브랜치(dev)는 어느 정도 작업이 완료된 코드를 합치는 경우에 활용합니다. 대부분 배포용 브랜치(master)에 코드를 합치기 전에 완료된 작업이 이전 작업과 충돌이 없이 잘 돌아가는지 확인하는 용도입니다. 또는 작업 중이던 코드를 지속적으로 합쳐서 개발되는 과정(기획 의도대로 개발이 진행되는지, 또는 기획에서 생각한 형태나 느낌이 맞는지 등을 보며 방향을 바꿀 필요가 있는지 체크하기 위해)을 지켜보기 위해 활용하기도 합니다.
그 외로 본인 작업은 항상 따로 브랜치를 생성해서 작업을 진행하는 것을 원칙으로 합니다. 작업이 완료되거나 개발 서버 등에서 확인이 필요할 때는 dev에 PR을 요청는 형식으로 진행하겠습니다.
작업을 Push할 때 key 값 등등 민감한 정보는 포함하지 않습니다. (현재 Repository는 공개 상태라 만약 민감한 정보가 push되면 악용될 수 있습니다.)
해당 부분은 매우 중요하기 때문에 작업을 push하실 때 항상 체크해주시길 바랍니다.
만약 민감한 정보를 실수로 올렸다면 (ex.비밀번호) 즉시 해당 비밀번호 등을 변경하시는 것을 권고 드리고 민감한 정보를 제거하고 추가 업데이트를 진행해주시면 됩니다.
(만약 하실 줄 아신다면 rebase 등을 통해 commit 자체를 날리는게 제일 좋습니다.)
Commit 메세지 형태는 따로 정하지 않겠습니다. 다만 Commit Message에 어떤 작업을 진행했는지 (What) 그리고 왜 진행했는지 (Why) 등의 내용은 꼭 포함하는걸로 하겠습니다. ex) Issue #12 해결을 위해 회원가입에 추가적으로 필요한 필드 추가.
다음 글을 읽어보시면 좋을 것 같습니다.
프로젝트 구조는 모든 작업을 한번에 모으기 위해서 capstone-design-I repository에 구성했습니다.
- backend -> 백앤드 프로젝트
- frontend -> 프론트앤드 프로젝트
그 외로 데이터 파이프라인 등등 프로젝트에 추가돼야할 부분이 생긴다면 추후에 구성하도록 하겠습니다.
작업할 때는 각자 보는 폴더가 정해져 있고 그 안에서만 작업하면 되도록 해놨습니다.
만약 궁금하다면 다른 사람의 프로젝트를 구경해보는 것도 좋을 것 같습니다.
대부분의 세팅은 이미 완료돼있기 때문에 작업할 때는 프레임워크의 구조나 설정을 건드리지 않아도 되도록 준비했습니다.
물론 설정을 건드리는 등 원하는 형태로 조정해도 됩니다.