[Good first issue] 增加免安装可读的投研报告示例

Đang mở
#71 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

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

Đánh giá

Độ khó
3/5
Thời gian dự kiến
Nửa ngày
Mức phù hợp với người mới
72/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ệ
markdown, typescript
Lĩnh vực
documentation

Hướng nghiên cứu

Start with reportFixture() in packages/shared/src/export/test-helpers.ts and reportToMarkdown() in packages/shared/src/export/markdown.ts, then run the export twice to confirm the output is stable. Commit a short synthetic Markdown report that states it is generated data, and check that each run ID in the evidence section matches a fixture record. Add a direct link from the English and Chinese README files, then verify the links in GitHub's Markdown preview. Before starting, post your intended scope and comment /claim as the issue asks.

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 help wanted priority:next

场景

访客现在可以看 README 截图和视频。再提供一份可以直接在 GitHub 阅读的短报告,让访客在安装前就能看懂一次研究如何从数据到结论,再用一个证据条目追溯到对应输入。

当前 reportFixture() 和 reportToMarkdown() 可以离线生成稳定结果。我用同一个 fixture 连续导出两次,正文一致,证据段保留了对应的 capability 和 run ID。

验收标准

  • 提交一份短 Markdown 示例报告,包含结论、风险和证据段。报告开头明确标注合成数据和生成方式。
  • 展示至少一个能从报告中的 run ID 查到对应 fixture 记录的例子,给出无需账号的再生成命令。
  • 从中英文 README 各加一个直接阅读的链接,用 GitHub Markdown 预览核对报告与源数据链接。

源码起点

认领前先说明准备完成的范围,再评论 /claim。参与方式见 #7。

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

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 ydflow/Trail

Tất cả issue của ydflow/Trail

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.