프로젝트 가이드

오픈 소스 프로젝트용 GitHub 릴리스 노트 템플릿

좋은 릴리스 노트는 업그레이드 여부와 다음 할 일을 알려 줍니다. 병합된 풀 리퀘스트 목록은 유용한 근거지만 전체 업그레이드 경험을 설명하는 경우는 드뭅니다. 게시 전에 사용자 영향과 필요한 작업을 추가하세요.

GitHubStart 편집팀 · 업데이트

사용자 중심 템플릿으로 시작하기

모든 대괄호 항목을 검증한 정보로 바꾸세요. 기능을 지어내지 말고 불필요한 절을 제거하세요. 지원되는 업그레이드 경로를 확인한 뒤 추가 작업이 필요 없다면 명시하세요.

# [버전] — [출시일]

## 주요 변경
- [사용자에게 보이는 개선과 혜택을 받는 대상]

## 업그레이드
- 이전 버전: [지원하는 이전 버전]
- 작업: [필수 마이그레이션 또는 작업 불필요]
- 확인: [업그레이드 성공 확인 방법]

## 호환성을 깨는 변경
- [변경된 동작, 영향받는 사용자, 마이그레이션 링크]

## 수정
- [해결한 문제와 이슈 또는 풀 리퀘스트 링크]

## 알려진 문제
- [남은 제약과 우회 방법]

## 기여자
[기여자에게 감사를 표하고 전체 변경 이력 링크 추가]

생성된 노트를 읽기 쉬운 설명으로 바꾸기

GitHub는 병합된 풀 리퀘스트, 기여자, 전체 변경 이력 링크를 포함하는 노트를 생성할 수 있습니다. 이를 초안으로 취급하세요. 릴리스 범위를 확인하고 무관한 항목을 제거하며 사용자가 하는 작업별로 변경을 묶으세요.

예를 들어 ‘파서 경계 사례 수정’만으로는 안내가 부족합니다. 사실에 맞는다면 마지막 열이 빈 CSV 파일이 이제 올바르게 가져와진다고 설명하고 기술 세부 내용은 수정 링크로 안내하세요. 한 가지 사례만 바뀌었는데 모든 파싱 문제가 해결되었다고 주장하지 마세요.

공지 전에 업그레이드 경로 검토하기

지원되는 이전 버전에서 문서의 업그레이드 절차를 시도하세요. 다운로드 링크를 확인하고 문서가 릴리스와 일치하는지 확인하세요. 미리보기와 안정 릴리스를 구분하고 남아 있는 제약을 쉽게 찾도록 하세요.

커뮤니티 게시물에서 링크하기 전에 릴리스 정보를 게시하세요. 공지에는 의미 있는 개선 하나를 강조하고 상세 참고 자료는 릴리스 노트에 남기세요. 후속 질문을 기록하고 필요할 때 안내를 명확히 하세요.

자주 묻는 질문

릴리스 노트는 변경 이력과 같은가요?

겹치는 부분이 있습니다. 변경 이력은 시간에 따른 변경을 기록하고 릴리스 노트는 특정 릴리스와 사용자 영향을 설명합니다. 서로 링크해 독자가 개요와 세부 내용을 오갈 수 있게 하세요.

자동 생성된 노트를 그대로 게시해도 되나요?

먼저 검토하세요. 생성된 풀 리퀘스트 제목에는 마이그레이션 단계, 사용자 영향, 알려진 문제가 빠져 있을 수 있습니다.

작은 코드 변경도 모두 주요 변경에 넣어야 하나요?

아닙니다. 사용자에게 중요한 변경을 강조하고 자세한 기술 이력은 링크된 변경 이력에 남기세요.

참고 자료