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

Option to overwrite project README when hydrating

Aberta
#588 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

enhancement
Linguagem predominante
Jinja
Estrelas
85
Forks
16
Merge médio
6h 18min
PRs com merge (30d)
1

Descrição

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

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Comece pelo caminho de hydration do template e inspecione como um GitHub README existente e vazio é detectado ou preservado. A tarefa estará concluída quando a hydration puder substituir esse README pelo README mais útil do projeto, e tanto o comportamento padrão quanto a opção de sobrescrita estiverem cobertos por testes.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
python
Domínio
developer-experience, tooling
Tipo de issue
Funcionalidade
Dificuldade
3/5
Tempo estimado
1-2 dias
Status de atividade
Pouca atividade
Clareza
Razoavelmente clara
Facilidade para iniciantes
58/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.