NerdConnection / Raspberry-Pi-5-Computer-Vision

Raspberry Pi 5 Computer Vision Suite
https://raspberry-pi-5-computer-vision.vercel.app
3 stars 3 forks source link

협업을 위한 여러 툴 사용 및 규칙 #18

Open NerdConnection opened 6 months ago

NerdConnection commented 6 months ago

이슈 Labels 활용

이슈를 더 직관적으로 확인하고 분류하기위해 이슈 작성시 Labels 기능을 활용하여 Label을 달아주셨으면 합니다.

태그 기능 활용

각각의 커밋에 버전 정보를 붙이고자 태그 기능을 활용해주면 좋을 것 같습니다. 예시로 컨테이너 내부에서 이미지를 확인할 수 있도록 하는 기능 추가했다는 의미로서 v1.1.0을 태그를 생성했습니다.

PR , Issue 템플릿

일관성 있는 정보 제공과 작업 내용 명시를 위해 통일된 템플릿이 필요하다고 생각했습니다. 이에 새로운 PR , Bug issue, Feature issue을 할 때 사용할 수 있는 템플릿을 만들어놓았습니다.

commit 메시지 규칙

코드 commit의 메시지 작성 시 통일된 규칙에 따라 작성해나가는 것이 좋을 것 같습니다. 아래의 링크를 참고해 숙지하여 일관된 commit 메시지를 작성해 나가시길 바랍니다.

https://velog.io/@chojs28/Git-%EC%BB%A4%EB%B0%8B-%EB%A9%94%EC%8B%9C%EC%A7%80-%EA%B7%9C%EC%B9%99 예시로 이번에 commit 메시지 내용을 공유합니다.

이전 commit 메시지 Using GUI by xServer

이후 commit 메시지 feat: Using GUI by xServer(#11)
connect xServer and Docker container to view images in container Resolves: #11

브런치 merge 규칙

각각의 branch 들을 main 으로 merge 시에 기본적인 규칙이 필요하다고 느꼈습니다. 이제부터는 한 명 이상의 코드리뷰를 통해 승인을 받아야 merge되도록 설정을 하였습니다.