PlasmaPy / PlasmaPy/plasmapy.github.io

Link to changelogs in docs instead of doing blog posts on each release

Offen
#127 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Python
Sterne
17
Forks
24
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

It's been pretty common for us me to forget to do the blog posts for the releases. If we have a feature release cadence of ∼3–4 months, we would end up needing to do this pretty often. The blog posts from the releases often repeat information from the changelog. I'm thinking that instead of having blog posts on each release, we should link to the changelog index page such that we won't need to update the webpage with each release.

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, die Release-Blogposts und die Changelog-Indexseite auf der Website zu finden. Bestätige, wo die Release-Links gepflegt werden, und aktualisiere dann die relevante Seite so, dass sie auf den Changelog-Index verweist, statt für jedes Release einen Blogpost zu erfordern. Die Aufgabe ist erledigt, wenn die Release-Dokumentation eindeutig auf den Changelog-Index verweist und kein Blog-Update pro Release erforderlich 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
38/100

Neue Issues direkt in Ihr Postfach

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