Reporsitory 관리 방법 논의
Opened this issue · 13 comments
Reporsitory 관리 방법 논의
앞으로 Dev-Docs Repository 관리 방안에 대해서 의견을 제시하고 방향성을 정해보는 시간
Contributors
추가 의견은 Comment로 달아주세요. 👍 Comment에 대한 결정의 과반수 혹은 대다수가 만족하는 경우 반영하도록 합니다.
👉 @BKJang @SeonHyungJo @Dae-Hwa @Eugene94 @JHRla
자신의 글을 올리는 방법(== Pull Request하는 방법)
[다른 이슈로 빼기]
❗️ ❗️ 꼭 지켜주세요 ❗️ ❗️
- 커밋 메시지
커밋 메시지는 통일을 합니다. 기본적인 이모지와 이름은 통일을 하며 뒤에 나오는 내용은 자유롭게 합니다. 단, 다른사람이 봐도 알아볼 수 있도록 합니다.
:pencil2: {자신의 이름} / {자세한 내용}
ex) :pencil2: SeonHyungJo / Add 최신_브라우저의_내부_살펴보기.md
- PR Branch
PR을 하는데 사용되는 브랜치는 통일을 합니다.
{ Date }/{ your_name }
ex) 20190512/SeonHyungJo
모든 날짜는 매주 일요일을 기준으로 하며 뒤에 위치하는 이름은 커밋메시지의 이름과 동일하게 합니다.
이렇게 사용하는 이유는 /를 기준으로 하나의 폴더처럼 보이게 되어 날짜별로 각각의 브랜치를 나눌 수 있으며 추후 1주가 밀리게 되는 경우 같은 브랜치를 사용하지 않는 방법으로 도입하게 되었습니다.
Merge 작업 관련
- Merge 작업은 일주일 동안 서로서로 리뷰를 달아준다.
- 차주 같이 보면서 내용을 살펴보고 추가 수정내용 확인 및 Merge를 진행한다.
- Merge된 브랜치는 삭제한다.
- 차주 작업된 내용은 Meeting-Minute, Dev-Docs READEME.md에 적는다.
Label(완료)
- needs review : 리뷰가 필요한 PR
- approval + 1 : Reviewer 중 1명이 승인한 경우(Comment와 함께 작성)
- approval + 2 : Reviewer 중 2명이 승인한 경우(Comment와 함께 작성)
- needs author response : 작성자의 응답이 필요한 경우
PR메세지의 커맨트에 본인의 글 주소를 링크하면 편할 것 같습니다.
변경요구를 해결한 상태의 태그가 있으면 좋을 것 같습니다!
@Dae-Hwa 변경요구 해결한 상태의 태그가 생겼을 때 관리는 어떻게 하는게 좋을까요? 해결이 되었다면 라벨을 넣고 다시 변경요구가 들어가면 라벨을 빼는 식으로 이루어져야 할까요?
@SeonHyungJo 현재 needs author response 태그를 붙였다 떼는 식으로 되어있는데 어차피 작성자가 작성한 뒤에 태그를 붙여야 한다면, 대응하는 태그를 만드는 것도 괜찮을 것 같습니다.
@SeonHyungJo 감사합니다! 😃
@SeonHyungJo @Dae-Hwa @Eugene94 @JHRla
Dev-Docs의 내용 중 중복되는 주제의 컨텐츠를 공부하고 발표하고 싶다면 기존의 있던 문서에 내용을 추가하거나 부족한 부분을 수정하여 작성하는 방식으로 하면 좋을 것 같습니다.
현재는 주제가 중복되더라도 무조건 새로운 문서를 작성하고 있는데 해당 방법은 불필요한 중복 내용이 많이 생기는 방식인 것 같고 비효율적인 부분도 있는 것 같습니다.
현재는 주제가 중복되더라도 무조건 새로운 문서를 작성하고 있는데 해당 방법은 불필요한 중복 내용이 많이 생기는 방식인 것 같고 비효율적인 부분도 있는 것 같습니다
중목방지 또는 새로운 내용 추가를 하기 위해서 모든 파일의 주제를 찾는데 한계가 있을 것 같아 주제를 관리하는 하나의 공간이 있으면 좋을 것 같습니다.
@SeonHyungJo 그 부분은 이슈로 관리하고 해당 내용들은 정리한 다음에 하나의 문서로 병합하는 시간을 가지면 좋을 것 같네요
현재 Dev-Docs관련 카테고리를 wiki로 옮기는 작업을 하고 있습니다. 앞으로는 READEME.md를 수정하지 마시고 wiki에 작성해주세요(merge 완료후)
@SeonHyungJo @Dae-Hwa @BKJang @Eugene94 @JHRla