Test that SPEC 3.6 lists every confirmable action

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#143 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
78/100
Loại issue
Tính năng
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
typescript
Lĩnh vực
testing

Hướng nghiên cứu

Đọc apps/api/src/modules/confirmations/domain/confirmation-token.ts để xem danh mục CONFIRMABLE_ACTIONS và kiểm tra mục 3.6 trong docs/SPEC.md. Tìm các quy ước hiện có về unit test và thêm một test kiểm tra xem từng action trong danh mục có được nhắc đến ở đó hay không. Hoàn tất khi test hiện tại chạy qua và thất bại nếu có action giả chưa được tài liệu hóa được thêm vào.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

documentation good first issue priority:P3 track:control-plane

CONFIRMABLE_ACTIONS in apps/api/src/modules/confirmations/domain/confirmation-token.ts is the closed catalog of destructive actions that need a confirmation.

Task

Add a unit test that reads docs/SPEC.md and fails when an action of the catalog is not mentioned in section 3.6, so the documentation cannot fall behind the code.

Acceptance

The test passes today and fails if you add a fake action to the catalog without documenting it.

Ngôn ngữ chính
TypeScript
Star
2
Fork
1
Merge trung bình
7 giờ 17 phút
Pull request đã merge (30 ngày)
197

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của shipkeepdev/shipkeep

Tất cả issue của shipkeepdev/shipkeep

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.