school-brainhack / school-brainhack/school-brainhack.github.io

Maintenance of [packaging] module

Offen
#369 0 Kommentare 2 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

maintainence
Vorherrschende Sprache
Jupyter Notebook
Sterne
42
Forks
185
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

Module to maintain

Website: https://school.brainhackmtl.org/modules/packaging/

Code: https://github.com/school-brainhack/school-brainhack.github.io/tree/main/content/en/modules/packaging

Work to be done

The Python packaging ecosystem has significantly evolved since this module content was originally developed. To ease maintenance burden and to better reflect current state-of-the-art, I would propose that the material should focus on the official Python packaging tutorial : https://packaging.python.org/en/latest/tutorials/packaging-projects/

I would also suggest that this tutorial could have more direct links with the testing module, as both the official tutorial and other, updated resources include testing in their initial package definition.

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

Überprüfe den Modulinhalt in content/en/modules/packaging und vergleiche ihn mit dem offiziellen Python packaging tutorial, das im Issue verlinkt ist. Prüfe das vorhandene Testmodul und die referenzierten Packaging-Hinweise auf relevante Zusammenhänge. Als abgeschlossen gilt die Arbeit, wenn das Packaging-Material die aktuellen Empfehlungen widerspiegelt und eindeutig auf Testressourcen verweist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
52/100

Neue Issues direkt in Ihr Postfach

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