KnpLabs / KnpLabs/php-github-api

Do not "help" the user by changing parameters

Offen
#566 2 Kommentare 4 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

enhancement
Vorherrschende Sprache
PHP
Sterne
2.2k
Forks
585
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

On 30+ places we have code like this:

if (!in_array($state, array('open', 'closed'))) {
    $state = 'open';
}

If the user misspelled the $state we should not help them. That may cause unpredicted actions. We should throw an exception or let the API call fail.

This is a BC break. I've marked it in milestone 3.0.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Durchsuche den PHP-Quellcode nach dem wiederholt verwendeten Muster zur Parameternormalisierung mit in_array und prüfe, wie ungültige API-Parameter derzeit fehlschlagen. Ermittle das konsistente Fehlerverhalten und identifiziere alle betroffenen Stellen; abgeschlossen ist die Aufgabe, wenn falsch geschriebene Parameter nicht mehr stillschweigend geändert werden und die bestehende Testsuite erfolgreich durchläuft.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
php
Bereich
api, backend
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.