15분
배지와 Changelog 읽기
Day 3: GitHub README 해독
배지와 Changelog 읽기
영어 문서 독해: API 문서, GitHub, Stack Overflow > Day 3: GitHub README 해독
학습 목표
GitHub 배지의 의미를 이해한다 Changelog에서 버전 변경사항을 파악할 수 있다
배지(Badge)란?
README 상단에 작은 이미지들이 있다.
에디터 로딩 중...
자주 보는 배지:
| 배지 | 의미 |
|---|---|
| PyPI version / npm version | 현재 패키지 버전 |
| Build Status (passing/failing) | CI 빌드 상태 |
| Coverage X% | 테스트 커버리지 |
| License: MIT | 라이선스 종류 |
| Downloads | 다운로드 수 |
빌드가 failing이면 주의! 현재 버전에 문제가 있을 수 있다.
Changelog / Release Notes
버전이 올라가면 뭐가 바뀌었는지 Changelog에 적혀있다.
에디터 로딩 중...
핵심 용어:
| 용어 | 의미 | 주의도 |
|---|---|---|
| Breaking Changes | 기존 코드 호환 안 됨 | 높음 |
| Deprecated | 곧 제거될 기능 | 중간 |
| Added | 새 기능 추가 | 낮음 |
| Fixed | 버그 수정 | 낮음 |
| Removed | 기능 제거됨 | 높음 |
Semantic Versioning
버전 번호: MAJOR.MINOR.PATCH
- MAJOR (1.0.0 -> 2.0.0): Breaking Changes
- MINOR (1.0.0 -> 1.1.0): 새 기능 추가 (호환 유지)
- PATCH (1.0.0 -> 1.0.1): 버그 수정
주의! MAJOR 버전이 올라가면 기존 코드가 안 돌 수 있다. 업그레이드 전에 Breaking Changes를 꼭 확인하자.