본문 바로가기
개발 기본 규칙 및 환경설정

[개발 규칙] 협업 규칙

by cogito21_cpp 2024. 7. 19.
반응형

1. 코드 스타일 가이드 설정

- 팀 내에서 사용할 코드 스타일 가이드를 선택하거나 정의

- Airbnb, Google, Standard 등 유명한 스타일 가이드를 참고

- 스타일 가이드 문서를 작성하고 공유

2. 코드 리뷰 프로세스

코드 리뷰 프로세스를 도입하여 코드 품질을 높이고 일관성을 유지

Pull Request (PR): 모든 변경 사항은 PR을 통해 제출

리뷰어 지정: 팀원이 번갈아 가며 리뷰를 담당

리뷰 가이드라인: 리뷰 시 확인해야 할 체크리스트를 작성

코드 리뷰 체크리스트 예시

- [ ] 코드 스타일 가이드를 준수했는가?
- [ ] 함수와 변수의 네이밍이 적절한가?
- [ ] 불필요한 콘솔 로그가 없는가?
- [ ] 주석이 충분히 작성되었는가?
- [ ] 예외 처리가 잘 되어 있는가?
- [ ] 테스트 코드가 추가되었는가?

 

3. 팀 내 교육 및 문서화

- 새로운 팀원이 들어오거나 협업이 시작될 때, 스타일 가이드와 도구 사용법을 문서화하여 공유

- 주기적인 교육 세션을 통해 팀원들이 일관된 코딩 스타일을 유지

4. 협업 도구

- 버전 관리: Git

- 프로젝트 관리: Jira, Trello, GitHub Projects, Notin

- 커뮤니케이션 도구: Slack, Discord, Notion, Microsoft Teams

 

반응형