Unity-Technologies / Unity-Technologies/UnityDataTools

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.

enhancement
Ngôn ngữ chính
C#
Star
821
Fork
71
Merge trung bình
3 giờ 13 phút
Pull request đã merge (30 ngày)
9

Mô tả

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).

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

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.

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.

Đánh giá

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

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.