analyze: print next-step guidance when the database is written

Đang mở Phù hợp với người mới
#116 1 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ó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
68/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
csharp, sqlite
Lĩnh vực
cli, database

Hướng nghiên cứu

Bắt đầu từ output hoàn tất của lệnh analyze và lần theo code in ra số lượng file đã xử lý cùng tổng thời gian. Thêm hướng dẫn được đề xuất về database, view và schema-reference sau khi database được ghi, rồi chạy analyze trên một input mẫu để xác minh nội dung stdout và URL.

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

Mô tả

enhancement

When analyze finishes it prints the processed-file counts and the total time, but nothing about what to do next:

Finalizing database. Successfully processed files: 2, Failed files: 0, Files without TypeTrees: 0, Ignored files: 0

Total time: 0.256 s

In a usability experiment, an AI agent given only the binary discovered the built-in views (object_view, view_breakdown_by_type, ...) by running .tables in sqlite3 and called it "a lucky/pleasant discovery, not something --help mentioned". For someone using the downloaded binary, stdout plus the one URL in --help is the entire discovery surface.

Proposal: after finalizing, print a short next-step hint, something like:

Database written to database.db. Start with the object_view and view_breakdown_by_type views.
Schema reference: https://github.com/Unity-Technologies/UnityDataTools/blob/main/Documentation/analyzer.md

The URL should be version-pinned once the --help documentation link is (tracked separately).

Ngôn ngữ chính
C#
Star
841
Fork
75
Merge trung bình
1 ngày 7 giờ
Pull request đã merge (30 ngày)
3

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

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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 Unity-Technologies/UnityDataTools

Tất cả issue của Unity-Technologies/UnityDataTools

Issue tương tự

Thêm issue về C#

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.