| YEP | 제목 | 저자 | 종류 | 상태 |
|---|---|---|---|---|
1 |
YEP의 목적과 가이드라인 |
메타 |
유효 |
YEP은 약속 개선 제안(Yaksok Enhancement Proposal)의 줄임말입니다.
각각의 YEP은 약속 프로그래밍 언어에 구현될 기능에 대한 명세라던지, 설계 철학, 생태계 가이드라인 등에 대한 제안 문서입니다.
이름을 포함한 여러 아이디어를 파이썬 프로그래밍 언어에 있는 PEP1에서 따왔습니다.
- 아이디어를 소통 채널에서 논의합니다.
- YEP 저자는 YEP 저장소를 포크한 뒤
yep-0000/README.md파일을 만듭니다.0000은 YEP 초안의 번호입니다. - README에 YEP 내용을 작성합니다.
- 커밋 & 푸시한 다음 PR을 등록합니다.
- YEP 편집자가 YEP 번호를 지정하고 PR을 병합합니다.
YEP 번호가 지정되고 YEPS 저장소에 병합되었다고 해서 YEP 문서가 승인된 것은 아닐 수 있습니다.
실제 승인 여부는 YEP 상태에 따라 결정됩니다.
각각의 YEP은 다음의 요소들을 갖고있거나 조건을 만족해야합니다:
- 프론트매터 - YEP 번호, 제목, 저자, 종류, 상태 등을 담고있는 프론트매터를 담고있어야 합니다.
- 초록 - 이 YEP 문서가 다루는 주제에 대한 간결한 설명을 담아야 합니다.
- 동기 - 약속 프로그래밍 언어나 라이브러리, 생태계에 변화를 주고자 하는 YEP 문서에는 어째서 기존의 명세로는 이 YEP 문서가 푸는 문제를 해결하기 불충분한지 깔끔하게 설명하는 동기가 꼭 필요합니다.
- 근거 - 같이 고려될 수 있는 대안 디자인들 중에서 어째서 이런 특정한 디자인 결정을 내렸는지에 대한 근거를 들어야 합니다.
근거로는 토론을 통해 커뮤니티의 합의를 얻었다는 흔적과, 토론중 발생한 주요 반대의견과 고려사항을 같이 제시해야 합니다. - 명세 - 새로운 언어 기능에 대한 문법이나 의미론을 기술하는 명세가 있어야 합니다.
명세는 주요 약속 플랫폼들이 참여하고 상호운용될 수 있을 정도로 충분히 자세히 기술되어야 합니다. - 참조 - YEP에서 참조로 사용한 URL을 모아서 볼 수 있도록 해야합니다.
- 저작권 - YEPS 저장소에 속한 모든 YEP 문서는 퍼블릭 도메인 또는 CCO2의 듀얼 라이센스 하에 배포되어야 합니다.
YEP을 기술하는 README.md의 상단에는 일정한 형식의 프론트매터(Front Matter)3가 들어가야 합니다.
YEP: 0 # YEP 번호를 작성합니다. 초안은 0으로 작성해두면 됩니다.
제목: 나의 멋진 YEP
저자: # 목록을 `이름 <이메일> (홈페이지)` 형식으로 작성합니다. 이메일과 홈페이지는 생략 가능합니다.
- 김약속 <[email protected]> (https://example.com/)
종류: 정보 # 표준, 정보, 메타
상태: 초안 # 초안, 유효, 승인, 완성, 거절, 폐기, 대체
대체: 123 # 상태가 '대체'일 경우 어떤 YEP에 의해 대체되었는지 번호를 작성합니다. 대체 상태가 아닐 경우 이 필드는 작성하지 않습니다.