python / python/devguide

Add information how to deal with incorporation external code (license, credits)

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

Personne n'a encore pris cette issue.

topic-dev process type-feature
Langage dominant
Python
Étoiles
2.1k
Forks
1k
Merge moyen
2 j 12 h
PR mergées (30 j)
12

Description

Describe the enhancement or feature you'd like
The devguide does not contain information what a triager and core dev has to do when adding files or non-trivial portions of code from an external project with non-core dev contributors. There are a couple of things we need to check or do:

  • Is the license compatible with PSFL?
  • Include proper provenance and license information in file header or comment before the code
  • Add license and origin to Docs/license.rst
  • Give credits to original authors
  • Properly document the provenance and license in commit message

Describe alternatives you've considered
We should ask VanL for guidance, too.

Additional context
See https://github.com/python/cpython/issues/95649 for a case that is missing proper license and provenance information.

Guide de contribution

Ouvrir le guide de contribution

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 examiner la structure de la documentation de devguide et l’issue 95649 correspondante de CPython, puis demandez à VanL quelles sont les directives prévues. Documentez les exigences relatives à la compatibilité des licences, à la provenance, aux crédits, à Docs/license.rst et aux messages de commit afin que la procédure soit complète et exploitable.

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
45/100

Recevez les nouvelles issues par e-mail

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