Đóng góp cho tài liệu UI
Giữ catalog chính xác khi UI dùng chung thay đổi. Thêm metadata, preview, bản dịch và test trong cùng thay đổi.
Quy trình
Dùng checklist này trước khi mở thay đổi tài liệu UI để review.
Cập nhật registry
Bắt đầu từ registry trong route để ID, danh mục, import, export và snippet cách dùng luôn nhất quán.
Thêm hoặc kiểm tra preview
Thêm preview gọn cho primitive an toàn. Đánh dấu app shell phức tạp là pattern preview khi không thể chạy riêng.
Ghi tài liệu thành phần
Mỗi thành phần công khai cần phần cài đặt, cách dùng, ví dụ, export API, điểm tùy biến và liên kết liên quan.
Cập nhật bản dịch
Thêm copy công khai vào cả bundle tiếng Anh và tiếng Việt, sau đó sắp xếp bundle.
Xác minh thay đổi
Chạy test toàn vẹn registry, test render route, test preview tập trung, type-check và repo check cuối khi có thể.
Tôn trọng luồng phát hành package
Không sửa thủ công phiên bản package hay metadata phát hành. Release Please quản lý việc bump package.
Xác minh
Dùng check tập trung trước, sau đó chạy các check repo bắt buộc cho TypeScript và message.
bun i18n:sort
bun --cwd apps/web test 'src/app/[locale]/ui/component-docs.test.ts'
bun --cwd apps/web test 'src/app/[locale]/ui/ui-docs-sidebar.test.tsx'
bun --cwd apps/web type-check