Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Hooks generator does not get all the PHP files to scan

Đang mở
#20 0 bình luận 1 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
1-2 ngày
Mức phù hợp với người mới
45/100
Loại issue
Lỗi
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
php
Lĩnh vực
documentation, tooling

Hướng nghiên cứu

Bắt đầu với script generate-hook-docs.php được tham chiếu và xem lại phần giải thích chi tiết trong bình luận PR google-listings-and-ads được liên kết. Chạy lại generator với một thư mục có các đường dẫn sâu hơn hai cấp, sau đó xác minh rằng tất cả các tệp PHP và các hook của chúng đều được đưa vào tài liệu được tạo.

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

Mô tả

Context

At Ventures team we would like to generate a hooks document for our internal use and we found there is an awesome script in this repo that just do the things we want. Here's our PR woocommerce/google-listings-and-ads#1573, it basically copy most of the code from the script and then modify a bit to suit what we need.

The Problem

We found the script does not capture all the PHP files in the directory, the TLDR reason is the script cannot work in the case where there are more than two levels of paths. Please see the detailed explanation in our PR's comment: https://github.com/woocommerce/google-listings-and-ads/pull/1573#issuecomment-1173318631.

It also relates to #15.

Our solution may not fulfil the needs in this repo, also if there's any better ways to generate hooks documents (like using PHPDoc?) in your mind, we're happy to hear and learn about.

Ngôn ngữ chính
Twig
Star
17
Fork
12
Merge trung bình
3 giờ 58 phút
Pull request đã merge (30 ngày)
3

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.

Issue khác của woocommerce/code-reference

Tất cả issue của woocommerce/code-reference

Issue tương tự

Thêm issue về Documentation

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.