문서 versioning 원칙

versioning 방식

첫번째 자리

• 개념적인 의미가 강합니다.

• 전체적인 단위의 철학의 변화가 있을때 변경합니다.

두번째 자리

• 큰 단위의 변화가 있을 경우 변경할 수 있습니다.

  • 큰 단위의 변화의 예시

    • 전체 로드맵 상에서 계획적 버전 업데이트가 필요할 경우

    • 많은 부분이 생성되는 경우

• breaking change가 있을 경우에는 반드시 변경합니다.

  • breaking change가 있는 경우 예시

    • 레이아웃의 삭제

    • 컴포넌트의 삭제

    • 컴포넌트의 prop 삭제

    • 컴포넌트의 prop value 삭제

    • …

• 삭제하는 행위의 경우 삭제가 결정된 시점에 ‘Deprecated’표시 이후 2버전간 유지한 후, 실제 문서에서 삭제해야합니다.

세번째 자리

• breaking change가 없는 대부분의 경우에 사용합니다.

  • breaking change가 없는 경우 예시

    • 레이아웃의 추가

    • 컴포넌트의 추가

    • 컴포넌트의 prop 추가

    • 컴포넌트의 prop value 추가

    • 레이아웃의 spec 변경

    • 컴포넌트의 spec 변경

    • …

문서 작성 정보