docs: add a README to @relkit/cli

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#176 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ó
1/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
90/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
bun, typescript
Lĩnh vực
documentation

Hướng nghiên cứu

Đọc WRITING.md và dùng packages/relkit/README.md làm mẫu. Thêm packages/cli/README.md mô tả lệnh relkit cùng các lệnh dev, check, build, add, deploy, migrate và mcp, cách cài đặt và liên kết đến tài liệu tham khảo CLI. Chạy bun run check; hoàn tất khi lệnh kiểm tra chạy đạt và README sẵn sàng hiển thị trên npm sau khi phát hành.

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

packages/cli has no README.md, so the package page on npm is empty.

What to do

  • Add packages/cli/README.md with: what @relkit/cli is (the relkit command: dev, check,
    build, add, deploy, migrate, mcp), how to install it, and a link to the
    CLI reference.
  • Use the product name RelKit in prose and follow WRITING.md.

Done when bun run check passes and the README renders on the package page after the next
release. packages/relkit/README.md is a good model.

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

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 rel-kit/relkit

Tất cả issue của rel-kit/relkit

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.