riseproject-dev / riseproject-dev/python-wheels

docs: clean up field usage

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

Personne n'a encore pris cette issue.

documentation enhancement good first issue infrastructure
Langage dominant
Python
Étoiles
0
Forks
0
Merge moyen
16 h 14 min
PR mergées (30 j)
952

Description

We currently have a mixture of several fields in our package docs. Between historic patterns and new workflows, each package may feature one or more of:

  1. comment - a generic field for providing commentary on a package. This was previously always used to provide a link to a GPL sources tarball if required for a package
  2. warning - usually used to indicate we've had to skip some sort of test or omit a piece of functionality in a module, due to incompatibility or known issues with riscv64 or our infrastructure
  3. patched - a typically blank field used to signal that the package is built with one or more patches applied during the process

These are all somewhat redundant. I propose two to replace these:

  1. gpl-sources - specify this with one or more links if we have to provide GPL source tarballs as part of the package builds
  2. comment - anything else (notes about patching, skipping tests, etc.) goes here

@justeph @luhenry thoughts?

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

L’issue ne nomme aucun fichier ni test spécifique ; commencez par localiser les champs de la documentation des packages qui utilisent actuellement comment, warning et patched. Confirmez le schéma de champs proposé avant de migrer les entrées : utilisez gpl-sources pour les liens vers les sources GPL et comment pour les autres remarques ; vérifiez ensuite qu’il ne reste aucune utilisation des anciens champs.

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é
Active
Clarté
Plutôt claire
Accessibilité débutants
48/100

Recevez les nouvelles issues par e-mail

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