patternfly / patternfly/patternfly-react

Update contribution guide to include guidelines for deprecated components

Offen
#9,460 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

PF Team Pinned
Vorherrschende Sprache
TypeScript
Sterne
862
Forks
392
Ø Merge
4 T. 8 Std.
Gemergte PRs (30 T.)
9

Beschreibung

Describe the enhancement or change
What it means for a component to be deprecated is currently unclear to our consumers.

Our contribution guidelines should explain what a component being deprecated entails, including how long it will still be available and how it impacts what work will be done on it going forward.


Jira Issue: PF-123

Beitragsleitfaden

Beitragsleitfaden öffnen

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

Beginne damit, den Contribution Guide des Repositorys zu finden, und prüfe die darin enthaltenen Hinweise zum Lebenszyklus von Komponenten. Aktualisiere den Guide so, dass definiert wird, was „deprecated“ bedeutet, wie lange deprecated Komponenten verfügbar bleiben und wie sich die Deprecation auf künftige Arbeiten auswirkt; als abgeschlossen gilt die Aufgabe, wenn diese Punkte für Verbraucher klar sind und die Dokumentationsprüfung erfolgreich ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
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.