Skip to content

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

AoifeHughes
Copy link
Contributor

Addresses: #620

@AoifeHughes AoifeHughes self-assigned this Jul 1, 2025
@AoifeHughes AoifeHughes added the enhancement New feature or request label Jul 1, 2025
Copy link
Contributor

github-actions bot commented Jul 1, 2025

Preview the changes: https://turinglang.org/docs/pr-previews/626
Please avoid using the search feature and navigation bar in PR previews!

@AoifeHughes AoifeHughes requested a review from Copilot July 7, 2025 09:27
@AoifeHughes AoifeHughes marked this pull request as ready for review July 7, 2025 09:27
Copy link

@Copilot Copilot AI left a 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, since Pkg.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

@AoifeHughes AoifeHughes requested a review from penelopeysm July 7, 2025 09:28
Copy link
Member

@penelopeysm penelopeysm left a 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants