20220329 개발일지 #실전프로젝트 ReadMe 작성하기

다른 팀원이 GitActions를 진행하면서 우리 백엔드 GitHub의 Setting이 모두에게 보여지지 않는다는 것을 알았다.

setting은 해당 Repository를 만든 사람만 접근이 가능하고, Collaborator로 초대된 다른 팀원들은 setting을 변경할 수 없다.

 

그래서 알아보던 중에 GitHub에 organization 기능이 있다는 것을 알았다!!

전에 이전 기수 깃허브를 보던 중에 팀으로 묶여있는 GitHub를 보면서 어떻게 했지, 궁금했던 기능인데(당시에는 아무리 검색해도 못찾았다!!) 이번에 알게 되었다.

 

organization을 하나 만들고, 거기로 repository를 transfer하면 해당 organization 안에 repo로 등록된다.

그래서 우리 팀을 새로운 organization으로 만들고, 모든 Repository를 여기로 옮겼다.

 

그리고 ReadMe 작성을 시작했다.

 

이미 배포된 팀들을 보면 GitHub는 공개가 되어있지만 Readme가 작성되어 있는 경우는 거의 없어서 아쉬웠다.

프론트에서 먼저 작성을 시작하셔서 전체 테마는 잡힌 상태였고, 개발자 커뮤니티 위주로 서비스 홍보를 할 계획이라 배포 전에 리드미가 있으면 훨씬 더 좋을 것 같았다!

 

수정된 아키텍처와 ERD를 그리고 API는 Swagger를 캡쳐해왔다.

Swagger는 이전부터 알고 있던 기능인데 notion으로 작업하는게 익숙하고, 실전프로젝트를 진행하면서 계속 마음만 급해서 빨리 도입하지 못한게 아쉽다.

여러 가지 기능을 제공하는 것 같고, 특히 spring에 연결해서 코드가 수정되면 바로 반영할 수 있다는 게 정말 좋은 것 같다.

다음에 또 프로젝트를 진행한다면 처음부터 바로 붙여서 써보고 싶다!!