Clarify commit suggestions
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
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
- Sem Dockerfile nem arquivo Docker Compose
- Sem modelo de pull request
- Ler o guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de Imageomics/Collaborative-distributed-science-guide
-
bug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
-
enhancement good first issue
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 72/100
-
enhancement good first issue
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 68/100
-
Add footnote hover?Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 48/100
-
Update GH PR Guide PageAbertadocumentation enhancement
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 65/100
Todas as issues de Imageomics/Collaborative-distributed-science-guide
Issues semelhantes
-
automated endpoint-dead needs-curation
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
almanac-data/climate-almanac#138 ·
Mantenedores costumam responder em até 1 dia
-
enhancement
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 67/100
OceanDataTools/openrvdas#760 ·
Mantenedores costumam responder em até 1 dia
-
level/subtask type/enhancement
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
wazuh/wazuh-virtual-machines#1091 ·
Mantenedores costumam responder em até 1 dia
-
Python: Bug: ChatMessageContent.from_element drops AudioContent and BinaryContent into raw TextContentTalvez já em andamento @halcyon-past assumiu hoje. Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
microsoft/semantic-kernel#14824 · 1 comentário ·
Mantenedores costumam responder em até 3 dias
-
help wanted
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
stack314/django-neolith#142 · 1 comentário ·
Mantenedores costumam responder em até 1 dia