Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Format code with JuliaFormatter #256

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

mofeing
Copy link

@mofeing mofeing commented Apr 22, 2024

This PR formats the code with JuliaFormatter and adds a couple of format checking workflows.

Also, add format checking workflows
Copy link
Member

@devmotion devmotion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before we format the code base, we have to agree on a code style. IMO we shouldn't rely on general defaults of JuliaFormatter but fix the style that's agreed on in a .JuliaFormatter.toml file in the repo.

I tend to use blue style (as e.g. ChainRulesCore: https://github.com/JuliaDiff/ChainRulesCore.jl/blob/main/.JuliaFormatter.toml) but there are of course other common styles.

.github/workflows/format-check.yml Outdated Show resolved Hide resolved
.github/workflows/format-pr.yml Outdated Show resolved Hide resolved
Copy link
Member

@devmotion devmotion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add the blue style badge to the README? Otherwise it looks good to me 🙂

.github/workflows/format.yml Outdated Show resolved Hide resolved
mofeing and others added 2 commits April 24, 2024 01:07
Co-authored-by: David Widmann <devmotion@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants