python / python/devguide

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

Offen
#928 2 Kommentare 3 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

topic-dev process type-feature
Vorherrschende Sprache
Python
Sterne
2.1k
Forks
1k
Ø Merge
2 T. 12 Std.
Gemergte PRs (30 T.)
12

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

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

Beginne damit, die Struktur der devguide-Dokumentation und den zugehörigen CPython-Issue 95649 zu prüfen, und frage anschließend VanL nach den vorgesehenen Hinweisen. Dokumentiere die Anforderungen an Lizenzkompatibilität, Provenienz, Credits, Docs/license.rst und Commit-Nachrichten, damit das Verfahren vollständig und umsetzbar ist.

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

Neue Issues direkt in Ihr Postfach

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