Conventions

[lovit]

• 며칠 간 작업을 함께 하면서 패키지 구조를 변경하는 일들이 발생했고, 그와 동시에 여러 개의 코퍼스에 대한 작업을 수행하다보니 conflict 가 날 가능성이 높아지고 있습니다.
• 코드 관리 및 이후에 다른 분들과의 협업을 위해서도 간단한 convention 을 논의해 보면 좋을 것 같아요.
• 아래에 comments 로 conventions 을 정하면 좋을 항목들을 열어두겠습니다. 수정을 통하여 내용을 보완해 보아요

commit conventions

• 모든 commit 은 관련 이슈를 먼저 생성하고, 해당 이슈에 대한 설명은 issue/comments 에서 설명/논의합니다.
• commit message 에 해당 이슈를 적어둡니다.

  Implement __len__ (#123)

branch conventions

• master 는 배포/공개용으로만, dev 를 개발용으로 이용합니다.
  • 세부 개발은 dev 에서 브랜칭을 한 뒤에 dev < feature 로 PR 보내주세요.
  • 버전업데이트, 배포가 될 때 master < dev 로 머징합니다.
  • 그러므로 README 등의 문서 내 typo 수정 역시 dev 이하의 브랜치에서 수행합니다.
• 한 브랜치 내에서는 그 브랜치에서 해결하려는 이슈에 관련된 파일만 수정합니다.
• petitions#5 branch 에서는 KoreanPetitions 만 수정해야하며, NSMC 는 수정하지 않습니다.
• NSMC 수정이 필요하다면 nsmc branch 에서 따로 작업합니다.
• rebase 로 commit history 순서를 정렬합니다.

PR conventions

• PR template 에 관련 이슈를 적는다. 두 개 이상의 이슈가 관련되어 있다면 모두 적는다.
  • 이슈가 없을 경우 생성하여 자세한 내용은 이슈에 기록한다.
  • typo 와 같이 이슈로 적을 필요가 없는 일에 대해서는 이슈를 적지 않아도 되며, 이때는 template 에 해당 내용을 간단히 기술한다.
• PR 은 1명 이상 approved 가 되면 merge 한다.

Description convension

• Korpus 에 입력되는 description 의 첫줄에는 author 를, 두번째 줄에는 repo 를, 세번째 줄에는 관련 reference 가 있다면 해당 reference 를 기술합니다. references 가 여러 개거나, 길이가 긴 경우에는 한 줄 띈 다음 - 기호로 구분하여 기록합니다. 코퍼스에 대한 설명은 한 줄 띈 다음에 자유롭게 기술합니다. 또한 description, license 는 4칸 들여쓰기 를 기준으로 작성합니다. (KorStS)

  Author : KakaoBrain
  Repository : https://github.com/kakaobrain/KorNLUDatasets
  References : 
      - Ham, J., Choe, Y. J., Park, K., Choi, I., & Soh, H. (2020). KorNLI and KorSTS: New Benchmark
         Datasets for Korean Natural Language Understanding. arXiv preprint arXiv:2004.03289.
         (https://arxiv.org/abs/2004.03289)

[ratsgo]

좋습니다!

[hungry-wook]

issue label 관련하여 제안드립니다. open issue 개수가 적지 않은데요, 이슈 관리와 가시성을 위해 아래 3가지 label을 사용하면 어떨까요?

• on progress : 작업 진행중
• major : 메이저 이슈
• minor : 마이너 이슈

[lovit]

on progress 는 누군가 해당 이슈 작업을 진행하면 레이블을 달아서 중복 작업을 방지하자는 의도이신가요?

저는 좋은 장치인듯합니다. 작업자들간의 혼란을 줄여줄 수 있는 방법이라 생각합니다

[ratsgo]

issue label 관련하여 제안드립니다. open issue 개수가 적지 않은데요, 이슈 관리와 가시성을 위해 아래 3가지 label을 사용하면 어떨까요?

• on progress : 작업 진행중
• major : 메이저 이슈
• minor : 마이너 이슈

좋은 아이디어 같습니다!

[lovit]

그럼 이건 우리 곧바로 적용해봐요 세 개의 레이블로 우선 시작해보고, 디테일하게 항목을 나눌 필요가 생기면 그때 논의해봐요

[hungry-wook]

넵 레이블 생성하였습니다. 현재 작업 중인 곳부터 적용해보면 좋을것 같습니다.

[lovit]

이후에 커멘트 추가할 때마다 새로운 내용이 아래로 밀릴테니, 정리된 내용은 맨 윗 커멘트에서 수정으로 업데이트 할게요. 중복되는 커멘트는 삭제하였습니다.