riseproject-dev / riseproject-dev/python-wheels

docs: PRs should only specify the license, not extract from LICENSE files

Ouverte
#385 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

Some upstream projects point at a license file with the license field in pyproject.toml. This causes our auto docs updates to pull in the entire license file's contents. This has not been a big issue since it isn't common, but it should be fixed so that the workflows/scripts only identify the correct license type and indicate it in the package's doc.

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

Commencez par localiser le workflow ou le script responsable des mises à jour automatiques de la documentation et examinez comment il lit le champ de licence de pyproject.toml. Vérifiez la modification avec un package dont le champ de licence pointe vers un fichier LICENSE ; la tâche est terminée lorsque la documentation du package identifie le type de licence sans inclure le contenu complet du fichier.

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

Évaluation

Stack technique
python
Domaine
documentation, tooling
Type d'issue
Bug
Difficulté
3/5
Temps estimé
1-2 jours
Activité
Active
Clarté
Plutôt claire
Accessibilité débutants
65/100

Recevez les nouvelles issues par e-mail

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