FluxML/Flux.jl

Figure out consistent code style

Open

#1.765 aberto em 12 de nov. de 2021

Ver no GitHub
 (9 comments) (0 reactions) (0 assignees)Julia (619 forks)batch import
discussionhelp wanted

Métricas do repositório

Stars
 (4.725 stars)
Métricas de merge de PR
 (Mesclagem média 4h 27m) (2 fundiu PRs em 30d)

Description

I've seen a few of files now in FluxML repos where the diffs ping-pong back and forth between different styles. Most of the discrepancy seems to be around function and type signature whitespace. Trailing whitespace too, my editor config is set to trim them and a surprising number of core files seem to have them.

ChainRulesCore recently added JuliaFormatter to their CI and it seems to be working well, but even just a couple of sentences in CONTRIBUTING.md would go a long way.

Guia do colaborador

Direção de pesquisa
A issue sugere implementar o JuliaFormatter no CI e adicionar diretrizes de estilo ao CONTRIBUTING.md. Revise o PR vinculado do ChainRulesCore (https://github.com/JuliaDiff/ChainRulesCore.jl/pull/482) para um exemplo. Verifique os comentários na issue para qualquer feedback dos mantenedores sobre escolhas de estilo preferidas. O objetivo é produzir um pull request que adicione um arquivo de configuração .JuliaFormatter.toml e atualize o guia de contribuição.
Pilha de tecnologia
None
Domain
developer experiencetooling
Tipo Issue
Manutenção
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Julia programming basicsUnderstanding of CI/CDCode formatting tools
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75