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

Maintenance of [packaging] module

Ouverte
#369 0 commentaires 2 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

maintainence
Langage dominant
Jupyter Notebook
Étoiles
42
Forks
185
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Examinez le contenu du module dans content/en/modules/packaging et comparez-le avec le tutoriel officiel Python packaging lié dans l’issue. Vérifiez le module de testing existant ainsi que les notes de packaging référencées pour repérer les liens pertinents. Le travail est considéré comme terminé lorsque le contenu sur le packaging reflète les recommandations actuelles et renvoie clairement vers les ressources de testing.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Documentation
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
52/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.