Loading...
Loading...
changes.md는 현재 릴리즈 버전의 변경사항만 기록하는 파일입니다. suneditor-demo 데모 업데이트, 릴리즈 노트 작성 시 참고 자료로 활용됩니다.release-note.md작성 직후 내용을 비우고 다음 버전을 위해 새로 작성합니다.
| 활용처 | 설명 |
|---|---|
| suneditor-demo | 데모 페이지에 새 기능/변경사항 반영 시 변경 목록으로 활용 |
| 릴리즈 메시지 | GitHub Release, npm publish 시 changelog 초안으로 활용 |
feat) — 데모에서 보여줄 수 있는 기능. 전에 못 하던 걸 옵션·UI로 할 수 있게 된 것fix) — 사용자에게 영향이 있는 수정enhance) — 기존 동작·UX·메시지·성능을 낫게 한 것, 또는 새 기능이 아닌 작은 공개 API 추가(헬퍼, 상수 등). 기존 코드는 같은 결과를 냄change) — 기존 코드는 동작하지만 결과가 달라지는 변경 (기본값, 스타일, 출력 등)style), 문서(docs), 테스트(test), CI/빌드 설정(ci, chore, build) 등 사용자에게 직접 영향이 없는 변경### feat
- 기능 설명 (`관련 파일 또는 플러그인`)
- 기능 설명 (#이슈번호)
### enhance
- 개선 내용 (`관련 파일 또는 플러그인`)
### fix
- 수정 내용 (`관련 파일 또는 플러그인`)
### change
- 동작 변경 설명
### breaking
- ⚠️ 변경 내용 — 마이그레이션 방법feat, enhance, fix, change, breaking
enhance vs change: 기존 코드가 같은 결과를 내면서 좋아지기만 하면 enhance, 결과가 달라져 사용자가 확인해야 하면 changebreaking 섹션에 별도 기재하고 마이그레이션 방법 포함/release-note로 changes.md를 release-note.md로 변환 (GitHub Release 본문, npm 패키지, suneditor-demo 업데이트가 이 파일을 사용)release-note.md 작성 직후 changes.md 내용을 모두 비움 (파일은 유지, 내용만 삭제)수정 완료 후 changes.md를 업데이트:
changes.md를 읽는다feat/enhance/fix/change/breaking)에 항목 추가style, docs, test, chore, ci, build 타입은 기록하지 않음git diff (staged + unstaged)를 실행하여 변경된 코드를 확인한다git diff HEAD~1로 최근 커밋의 변경사항을 확인한다featenhancefixchangebreakingchanges.md를 읽고, 중복되지 않는 항목만 적절한 그룹에 추가한다