FluxML/Flux.jl

Figure out consistent code style

Open

#1,765 创建于 2021年11月12日

在 GitHub 查看
 (9 评论) (0 反应) (0 负责人)Julia (4,725 star) (619 fork)batch import
discussionhelp wanted

描述

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.

贡献者指南

技术栈
无
领域
developer experiencetooling
议题类型
chore
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Julia programming basicsUnderstanding of CI/CDCode formatting tools
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75
研究方向
The issue suggests implementing JuliaFormatter in CI and adding style guidelines to CONTRIBUTING.md. Review the linked PR from ChainRulesCore (https://github.com/JuliaDiff/ChainRulesCore.jl/pull/482) for an example. Check comments in the issue for any maintainer feedback on preferred style choices. The goal is to produce a pull request that adds a .JuliaFormatter.toml config file and updates the contributing guide.
Figure out consistent code style · FluxML/Flux.jl#1765 | Good First Issue