Replace query-parameter spreadsheet with "ask the sim".
@zepumph đang làm issue này rồi.
Từ ngày 1/4/2025.
Đánh giá
Issue này chưa được đánh giá.
Mô tả
This came up at 8/5/21 dev meeting, and I volunteered to create this issue.
In Jauary 2021, @kathy-phet wanted a list of public query parameters supported by sims. So over in https://github.com/phetsims/tasks/issues/1076, we populated @kathy-phet's 2021 PhET Sim: Query Parameter Review spreadsheet.
Problems with this spreadsheet:
- It has been difficult to maintain because it's not in GitHub.
- It's almost certainly out of sync with reality. Based on discussion at 8/5/21 dev meeting, developers have not been updating it, and some didn't know the spreadsheet existed.
- Info in the spreadsheet may be wrong, and there's no way to check (not even with master branch of a sim.)
- It does not tell you what query parameters are supported by a specific version of a sim.
- It tells you nothing about a query parameter's type, valid values, default value, etc.
The proposal is to replace the spreadsheet with a query parameter that causes the sim to print its list of (public) query parameters to the console. All of my sims currently support something similar: with ?log, the full set of supported query parameters (public and internal) are printed to the console.
Questions for @kathy-phet:
(1) Are you OK with abandoning the spreadsheet and going with this new approach?
(2) Is it OK to just print query parameter names and their values? Or do we need to print more info, like type, valid values, doc, etc? The former is relatively easy, the latter will increase cost.
(3) What name would you like for this new query parameter? printPublicQueryParameters?
Assigning to @kathy-phet to reply to the above questions. Putting on the Developer project board for triage.
- Ngôn ngữ chính
- TypeScript
- Star
- 3
- Fork
- 5
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
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
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của phetsims/query-string-machine
-
Develop Next-Gen Query MachineĐang mởtype:epic
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 20/100
phetsims/query-string-machine#51 · 2 bình luận ·
-
dev:code-review
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 30/100
phetsims/query-string-machine#43 · 10 bình luận ·
-
type:misc
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 30/100
-
type:misc
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 25/100
phetsims/query-string-machine#36 · 2 bình luận ·
-
phetsims/query-string-machine#29 · 8 bình luận · 1 người được giao ·
Tất cả issue của phetsims/query-string-machine
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
callstackincubator/rozenite#518 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Area/Workflow Priority/Blocker Type/Bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
wso2/product-integrator#2622 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
-
area:bash bug has repro platform:macos
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
anthropics/claude-code#98644 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
allure-framework/allure-js#1603 ·
Maintainer thường phản hồi trong vòng 1 ngày