riseproject-dev / riseproject-dev/python-wheels

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

Aperta
#385 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

documentation enhancement good first issue infrastructure
Lingua principale
Python
Stelle
0
Fork
0
Merge medio
16h 14m
PR unite (30g)
952

Descrizione

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.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia individuando il workflow o lo script responsabile degli aggiornamenti automatici della documentazione e verifica come legge il campo della licenza da pyproject.toml. Verifica la modifica con un pacchetto il cui campo della licenza punta a un file LICENSE; la modifica è completata quando la documentazione del pacchetto identifica il tipo di licenza senza includere il contenuto completo del file.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
documentation, tooling
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Attiva
Chiarezza
Abbastanza chiara
Idoneità per principianti
65/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.