Skip to content

docs: 1.0 안정성 문구를 npm 페이지에도 (1.0.1) - #32

Merged
jlc488 merged 1 commit into
mainfrom
docs/package-readme-stability
Aug 8, 2026
Merged

docs: 1.0 안정성 문구를 npm 페이지에도 (1.0.1)#32
jlc488 merged 1 commit into
mainfrom
docs/package-readme-stability

Conversation

@jlc488

@jlc488 jlc488 commented Aug 8, 2026

Copy link
Copy Markdown
Contributor

1.0.0 발행 후 레지스트리에서 실제 내용을 검증하다 발견한 구멍입니다.

안정성 섹션을 루트 README에만 넣었는데, npmjs는 패키지별 README를 렌더합니다. 그래서 네 개 npm 페이지 전부 1.0.0을 표시하면서 "stable이 무엇을 보장하는지"는 한 줄도 없었습니다 — 채택 결정이 일어나는 바로 그 자리에서, 이번 릴리스의 존재 이유가 빠져 있던 셈입니다.

  • 패키지 README 8개(en·ko) 상단에 약속 한 줄 + 전체 범위 링크
  • npm 버전은 불변이라 npmjs에 보이는 걸 고치려면 릴리스가 필요합니다 (0.12.2가 있었던 것과 같은 이유)

검증

  • 99 테스트 그린, check:versions 1.0.1에서 클린
  • 8개 파일 전부 빈 줄 분리 확인 — 안 그러면 마크다운이 nav 줄과 한 문단으로 합쳐 렌더됨

참고로 이 작업 중 인라인 node -e의 정규식이 셸 이스케이프에 뭉개져 done만 출력하고 아무것도 안 쓴 일이 있었습니다. diff로 확인해서 잡았고, 스크립트 파일로 다시 했습니다.

Verifying the 1.0.0 publish against the registry turned up the gap: the
stability section landed only in the root README, but npmjs renders each
package's own README. So all four npm pages showed 1.0.0 with no word on
what stable means — and the npm page is where adoption is decided, which
was the entire point of the release.

Each package README (en + ko) now opens with the commitment and links to
the full scope in the root README. npm versions are immutable, so fixing
what npmjs shows needs a release; same reason 0.12.2 existed.

Verified: 99 tests green, check:versions clean at 1.0.1, blank-line
separation confirmed in all 8 files so the line renders as its own
paragraph rather than joining the nav line.
@jlc488
jlc488 merged commit 429e15e into main Aug 8, 2026
1 check passed
@jlc488
jlc488 deleted the docs/package-readme-stability branch August 8, 2026 02:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant