Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Replace query-parameter spreadsheet with "ask the sim".

Aperta
#46 6 commenti 0 reazioni 2 assegnatari Vedi su GitHub

@zepumph ci sta già lavorando.

Dal 1/4/2025.

Valutazione

Questa issue non è ancora stata valutata.

Descrizione

priority:5-deferred

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.

Lingua principale
TypeScript
Stelle
3
Fork
5
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di phetsims/query-string-machine

Tutte le issue di phetsims/query-string-machine

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.