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.

Sign up for GitHub

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

Jump to bottom

Consistently use camelcase/snakecase in aztec.nr #1928

Closed
ludamad opened this issue Sep 1, 2023 · 1 comment · Fixed by #5381
Closed

Consistently use camelcase/snakecase in aztec.nr #1928

ludamad opened this issue Sep 1, 2023 · 1 comment · Fixed by #5381
Assignees
@sklppy88
Labels
C-aztec.nr Component: Aztec smart contract framework

Comments

@ludamad
Copy link
Collaborator

ludamad commented Sep 1, 2023 •
edited
Loading

Rust has the convention of using CamelCase for types and snake_case for everything else.
Presumably, aztec.nr should inherit Rust's convention.

Task:

  • Take all existing camelCase methods, variable names, and other non-type symbols and rename to snake_case. I think types are all currently correctly CamelCase.

Considerations:

  • Consider getting the PR in at a quieter time and alerting other aztec.nr devs to pull to prevent too many conflicts.
@ludamad ludamad added the C-aztec.nr Component: Aztec smart contract framework label Sep 1, 2023
@github-project-automation github-project-automation bot moved this to Todo in A3 Sep 1, 2023
@iAmMichaelConnor
Copy link
Contributor

iAmMichaelConnor commented Sep 1, 2023 •
edited
Loading

We should follow Noir/Rust naming conventions, not C++ (although they might overlap mostly)

@spalladino spalladino mentioned this issue Sep 6, 2023
Closed
@sklppy88 sklppy88 self-assigned this Mar 21, 2024
@sklppy88 sklppy88 mentioned this issue Mar 21, 2024
Closed
@sklppy88 sklppy88 moved this from Todo to In Progress in A3 Mar 21, 2024
@sklppy88 sklppy88 mentioned this issue Mar 21, 2024
Merged
@sklppy88 sklppy88 moved this from In Progress to In Review in A3 Mar 21, 2024
ludamad pushed a commit that referenced this issue Mar 22, 2024
@sklppy88
refactor: camelCase in noir-projects -> snake_case (#5381)
eea711f 
Can we add a ci check for style on noir code so this doesn't creep back
in again?

Resolves #1928.
@github-project-automation github-project-automation bot moved this from In Review to Done in A3 Mar 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sklppy88 sklppy88

Labels
C-aztec.nr Component: Aztec smart contract framework
Projects
A3
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

refactor: camelCase in noir-projects -> snake_case AztecProtocol/aztec-packages
3 participants
@ludamad @iAmMichaelConnor @sklppy88