Project Convention
효율적이고 체계적인 방식으로 협업을 하며 프로젝트 개발을 진행하고자 프로젝트에 적용할 컨벤션을 많이 고민하였습니다.
많은 고민 끝에 프로젝트에 적용할 여러 가지 컨벤션을 고안하고 지정하였습니다!
작업에 필요한 여러가지 라벨을 지정하였습니다. 이를 통해 팀원이 요청하는 작업이 어떠한 분야에 해당되는지 쉽게 파악할 수 있었습니다.
프로젝트의 작업을 크게 5종류로 분류하고 마일스톤을 지정하였습니다. 이를 통해 해당 분야의 작업의 진행도를 쉽게 파악할 수 있었습니다.
프로젝트 개발 과정 중 발생하는 문제를 공유하고 함께 해결하기 위하여 Issue 기능을 사용하기로 하였습니다.
- GitHub Issues를 사용하여 GitHub에서 아이디어, 피드백, 작업 또는 작업에 대한 버그를 추적합니다.
- 문제가 발생하면 GitHub에서 작업을 추적할 수 있으며, 여기에서 개발이 이루어집니다.
- Issue가 발생할 경우, issue를 생성합니다.
- Template에 맞게 issue의 내용을 작성합니다.
- Issue의 경우, 자기 자신만을 Assignees로 지정합니다.
- 해당 이슈에 맞는 Label들을 선택하여 이슈의 성격을 쉽게 파악하도록 합니다.
- 해당 이슈에 맞는 Project를 선택하여 칸반보드와 연동합니다.
- 해당 이슈에 맞는 Milestone을 선택하여 작업 진행 상황을 쉽게 공유할 수 있도록 합니다.
- 이슈를 올리면, Slack이나 카카오톡을 통해 공유 부탁합니다!
Github Issue 기능을 이용하여 프로젝트 개발 시 발생한 이슈를 공유하고 함께 해결해나갔습니다.
Pull Request에 Template을 도입하여 일관성있고 가독성이 높은 Pull Request를 만들고자 하였습니다.
- 끌어오기 요청을 사용하면 GitHub의 리포지토리에서 분기로 푸시한 변경 내용에 대해 다른 사용자에게 알릴 수 있습니다.
- 끌어오기 요청이 열리면 공동 작업자와 잠재적인 변경 내용을 논의 및 검토하는 한 편 변경 내용이 기본 분기에 병합되기 전에 후속 커밋을 추가할 수 있습니다.
- 작업물을 main에 반영하고자 할 경우, pull request를 생성합니다.
- Template에 맞게 pull request의 내용을 작성합니다.
- 같은 Domain을 담당하는 동료 1명과, PM을 Assignees와 Reviewer로 지정합니다.
- 해당 pr에 맞는 Label들을 선택하여 pr의 성격을 쉽게 파악하도록 합니다.
- 해당 pr에 맞는 Project를 선택하여 칸반보드와 연동합니다.
- 해당 pr에 맞는 Milestone을 선택하여 작업 진행 상황을 쉽게 공유할 수 있도록 합니다.
- pr을 올리면, Slack이나 카카오톡을 통해 공유 부탁합니다!
Pull Request에 Template, Label, Milestone을 적용하여서 쉽고 빠르게 팀원의 PR을 이해할 수 있도록 하였습니다.
https://docs.github.com/ko/issues/tracking-your-work-with-issues/about-issues https://docs.github.com/ko/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests