Clarify commit suggestions

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

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
Meio dia
Facilidade para iniciantes
45/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
git
Domínio
documentation

Direção de pesquisa

Comece pela seção vinculada “Formatting and Naming Conventions” no Collaborative Distributed Science Guide e revise suas orientações atuais sobre commits. Considera-se concluído quando a seção explicar claramente a finalidade das mensagens de commit, a legibilidade e a compreensão do trabalho realizado, incluir links para boas práticas de commits legíveis por máquina e enfatizar por que as alterações são feitas.

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

Descrição

design documentation help wanted question

The Formatting and Naming Conventions section could use a re-visit. I think we need to elevate the commit portion, but also make it more in-line with practice. We should summarize the purpose of commit messages, highlighting important aspects of readability and understanding processes done. Then also link to good practices for, e.g., machine-readability and such, but the ultimate goal of understandable commits (why is this change happening) needs to be expressed clearly.

Linguagem predominante
Python
Estrelas
1
Forks
1
Merge médio
6d 1h
PRs com merge (30d)
1

Preparar o ambiente

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.

Mais de Imageomics/Collaborative-distributed-science-guide

Todas as issues de Imageomics/Collaborative-distributed-science-guide

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

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