lincc-frameworks / lincc-frameworks/python-project-template

Option to overwrite project README when hydrating

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

Nessuno ha ancora preso questa issue.

enhancement
Lingua principale
Jinja
Stelle
85
Fork
16
Merge medio
6h 18m
PR unite (30g)
1

Descrizione

"Oh no! It does this thing where it doesn't overwrite the readme, and we do a lot of badges and things in there. We should change that," @delucchi-cmu says, while hydrating desi-aap for the incubator.

I agree--if you're hydrating a fresh github repo, there's a good chance you clicked the option to create a blank README, so it'd be really nice to have it replaced with something more useful.

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 dal percorso di hydration del template e verifica come viene rilevato o preservato un GitHub README esistente e vuoto. Il lavoro è completato quando hydration può sostituire quel README con il README del progetto, più utile, e sia il comportamento predefinito sia l’opzione di sovrascrittura sono coperti dai test.

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

Valutazione

Stack tecnologico
python
Ambito
developer-experience, tooling
Tipo di issue
Funzionalità
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Tranquilla
Chiarezza
Abbastanza chiara
Idoneità per principianti
58/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.