FluxML/Flux.jl

Figure out consistent code style

Closed

#1,765 opened on Nov 12, 2021

View on GitHubContributor guide
 (9 comments) (0 reactions) (0 assignees)Julia (619 forks)batch import
discussionhelp wanted

Repository metrics

Stars
 (4,725 stars)
PR merge metrics
 (Avg merge 3d 6h) (6 merged PRs in 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.

Contributor guide

Research direction
Review existing code style discussions in the repository and propose a consistent formatting style using JuliaFormatter.
Tech stack
None
Domain
documentationdeveloper experience
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJulia
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75