[discussion] readme : objective descriptions

[bloomspes]

objective 에 해당하는 설명이 레포지토리의 목적을 밝히는 데에 조금 불충분 한 것 같다고 느껴집니다.
멤버 관리를 위한 깃허브 워크플로우 로 간단하게 설명을 남기고,
yaml 파일 작성법은 모두 how to use로 내리는 것이 다른 사람들이 보기에 좋은 가독성을 남길 것 같아요.
어떻게 생각하시나요?

[deep-diver]

사람에 따라 다르긴 한데, 목적을 파악하는 데는 충분했던것 같습니다.

• 다만 추가적인 설명을 한다면, 박박사님께서 채널에서 처음에 나열한 시나리오 내용을 포함하는것도 좋을것 같네요.

그 외 yaml 작성법이나 how to use 는 구현이 어느정도 이루어진 뒤 작성되는게 좋지 않을까요? 별도의 design doc 같은걸 작성하는것은 찬성입니다.

[kkweon]

말그대로 지금단계에서 README는 아주 간략히 적어놓은건데요

GitHub org 멤버쉽을 YAML로 선언적으로 관리한다.

라고만 쓰여져 있는 것인데요. 현재 단계에서 굳이 수정할 필요는 없어 보이는데 원하신다면 수정해서 PR 보내주시면 좋을 것 같네요.

한가지 유의할 점은, 개발이 완료되고 난 후라면, 목적보다는 무엇을 하는지 / 어떻게 사용하는지가 제일 상단에 위치해야 겠습니다.

지금도 사실 목적을 적으려는게 아니라 개발이 완료 되지 않아서 현재 목표를 적어놓은 것에 가깝습니다.