[핸드북] 핸드북 작성 양식 논의

[josworks27]

개요

• 현재까지 추가된 핸드북 내용들과 앞으로의 컨트리뷰팅에 사용될 통일성 있는 양식작성 논의

논의가 필요한 사항

• 현재 작성되어 있는 양식에 대한 보완점 의견 개진
• 다른 오픈소스에서 사용되었거나 사용하고 있는 참고할 수 있는 양식 공유
• 기타

현재 양식 👇

https://www.notion.so/Rule-0ac411634c284a3fbd5b7274f4827cd7

[greatSumini]

지금까지 작성된 내용을 CONTRIBUTING에 올려놓고, 추가 논의는 각 개선 PR들에서 리뷰로 진행하는건 어떨까용??

[josworks27]

의견 감사합니다 ! PR로 의견 개진 후 변경하는 방법 좋을 것 같습니다. 다만, CONTRIBUTING에 올리면서 각 규칙마다의 간단한 예제들을 추가하는 작업도 같이 수반되어야 할 것 같습니다.

추가적으로 각 PR을 통해 변경된 규칙이 있다면 기존에 올라온 양식들의 변경은 어떻게 효과적으로 관리할 수 있을까요 ?
추가되는 핸드북의 양이 많을수록 관리하기 점점 어려워질 수 있다는 생각이 드네요.

제 생각엔 해볼 수 있는 방법으로는 아래 두 가지 정도가 생각납니다.

1. PR을 통해 변경사항을 올릴 때, CONTRIBUTING과 기존 핸드북의 해당하는 규칙을 모두 변경 후 PR한다.
2. CONTRIBUTING에 대한 변경사항 PR을 올리고, 반영된다면 후속작업에 대한 이슈 생성 후 기존 핸드북을 변경한 PR을 추가적으로 올린다.

[milooy]

@josworks27 님 의견 보니 일단 1차 완성본까지는 디스커션에서 논의하고 어느정도 다듬어지면 PR로 올려야겠군요 ㅎㅎ 매번 수정할수없으니..
이 초안 베이스로 다음주 Weekly에서 같이 정해볼까요?

[josworks27]

@milooy 넵 좋습니다 ! 말씀하신 대로 매번 수정할 수 없는 작업이라 초안을 다 같이 논의해 보는 선행작업이 필요하다고 생각합니다 😀