Write the 1.0 documentation

Đang mở
#53 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ó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
43/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
javascript, markdown, node.js
Lĩnh vực
documentation

Hướng nghiên cứu

Read CONTRIBUTING.md and the linked roadmap section first. The requested deliverables are an animated demo at the top of README, a full usage guide, and troubleshooting guidance; use the existing CLI behavior as the source for those docs. Done means the README and guide cover these areas and the roadmap item is ticked; the issue also lists broader release and stability criteria, so clarify the documentation scope before starting.

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

Mô tả

enhancement help wanted

Roadmap: Hardening and release candidate

An animated demo (asciinema or GIF) at the top of the README, a full usage guide and a troubleshooting section.

Done when

  • Tests cover the change, and coverage stays at or above 90% of lines
  • The README describes the change, and the header comment of each touched lib/ file is up to date
  • CI passes on Windows, macOS and Linux with Node 22, 24 and 26
  • The roadmap item is ticked

The milestone is done when: Two weeks pass without new bugs that would require changing the public interface.

Comment here before starting, so the issue can be assigned to you. See CONTRIBUTING.md.

Ngôn ngữ chính
JavaScript
Star
0
Fork
0
Merge trung bình
56 phút
Pull request đã merge (30 ngày)
23

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 modulane/dev-workspace-cli

Tất cả issue của modulane/dev-workspace-cli

Issue tương tự

Thêm issue về JavaScript

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.