riseproject-dev / riseproject-dev/python-wheels
docs: PRs should only specify the license, not extract from LICENSE files
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 0
- Forks
- 0
- Ø Merge
- 16 Std. 14 Min.
- Gemergte PRs (30 T.)
- 952
Beschreibung
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.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, den Workflow oder das Skript zu lokalisieren, das für automatische Dokumentationsaktualisierungen verantwortlich ist, und prüfe, wie es das Lizenzfeld aus pyproject.toml liest. Verifiziere die Änderung mit einem Paket, dessen Lizenzfeld auf eine LICENSE-Datei verweist; als abgeschlossen gilt die Aufgabe, wenn die Paketdokumentation den Lizenztyp angibt, ohne den vollständigen Dateiinhalt einzuschließen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation, tooling
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Aktiv
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 65/100