-
Notifications
You must be signed in to change notification settings - Fork 103
Adding some formatting instructions for contributing #626
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
base: main
Are you sure you want to change the base?
Conversation
Preview the changes: https://turinglang.org/docs/pr-previews/626 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds a new "Code Formatting" section to the contributing guide to ensure consistent styling across the Turing codebase.
- Introduces instructions for installing JuliaFormatter v1 in the global environment.
- Provides a command to run JuliaFormatter on all project files before committing.
Comments suppressed due to low confidence (2)
developers/contributing/index.qmd:61
- The
Pkg.activate()
call without arguments may activate the local project instead of the global environment. Consider specifying the global environment path explicitly (e.g.,Pkg.activate("~/.julia/environments/v1.x")
) or omitting it, sincePkg.add
defaults to the active user environment.
julia -e 'using Pkg; Pkg.activate(); Pkg.add(name="JuliaFormatter", version="1"); Pkg.pin("JuliaFormatter")'
developers/contributing/index.qmd:52
- [nitpick] It may be helpful to mention that users can customize formatting rules with a
.JuliaFormatter.toml
configuration file in the repo root to enforce project-specific style options.
### Code Formatting
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! Just a couple of tiny suggested changes.
General request: could you insert semantic line-breaks, please? Just to keep diffs easier in the future.
Co-authored-by: Penelope Yong <[email protected]>
Co-authored-by: Penelope Yong <[email protected]>
Addresses: #620