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

Option to overwrite project README when hydrating

Ouverte
#588 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

enhancement
Langage dominant
Jinja
Étoiles
85
Forks
16
Merge moyen
6 h 18 min
PR mergées (30 j)
1

Description

"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.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

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 le chemin d’hydration du template et examinez comment un GitHub README vide existant est détecté ou conservé. Le travail est terminé lorsque l’hydration peut remplacer ce README par le README du projet, plus utile, et que le comportement par défaut ainsi que l’option d’écrasement sont couverts par des tests.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
developer-experience, tooling
Type d'issue
Fonctionnalité
Difficulté
3/5
Temps estimé
1-2 jours
Activité
Calme
Clarté
Plutôt claire
Accessibilité débutants
58/100

Recevez les nouvelles issues par e-mail

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