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

Follow ledger naming #120

Merged
merged 1 commit into from
Jul 19, 2023
Merged

Follow ledger naming #120

merged 1 commit into from
Jul 19, 2023

Conversation

newhoggy
Copy link
Collaborator

@newhoggy newhoggy commented Jul 16, 2023

Changelog

- description: |
    Follow ledger naming:
    - `Vote` -> `VotingProcedure`
    - `GovernanceActionIdentifier` -> `GovernanceActionId`
    - `makeGoveranceActionIdentifier` -> `makeGoveranceActionId`
    - `VoterType` -> `Voter`
    - `VoteChoice` -> `Vote`
  compatibility: breaking
  type: maintenance

Context

Staying with the naming from ledger so that the same terms can be used everywhere. This avoids having to learn multiple terms for the same thing.

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • The change log section in the PR description has been filled in
  • New tests are added if needed and existing tests are updated. These may include:
    • golden tests
    • property tests
    • roundtrip tests
  • The version bounds in .cabal files are updated
  • CI passes. See note on CI. The following CI checks are required:
    • Code is linted with hlint. See .github/workflows/check-hlint.yml to get the hlint version
    • Code is formatted with stylish-haskell. See .github/workflows/stylish-haskell.yml to get the stylish-haskell version
    • Code builds on Linux, MacOS and Windows for ghc-8.10.7 and ghc-9.2.7
  • The changelog section in the PR is updated to describe the change
  • Self-reviewed the diff

Note on CI

If your PR is from a fork, the necessary CI jobs won't trigger automatically for security reasons.
You will need to get someone with write privileges. Please contact IOG node developers to do this
for you.

@newhoggy newhoggy changed the title Newhoggy/follow ledger naming Follow ledger naming Jul 16, 2023
@newhoggy newhoggy marked this pull request as ready for review July 16, 2023 03:47
@newhoggy newhoggy force-pushed the newhoggy/follow-ledger-naming branch 2 times, most recently from dd5201f to d769a31 Compare July 16, 2023 03:51
Copy link
Contributor

@Jimbo4350 Jimbo4350 left a comment

Choose a reason for hiding this comment

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

You'll need to rebase this but what would actually be better than renaming to follow the ledger naming convention is to directly use the ledger types. Be sure to use Cardano.Api.Ledger so that we can make the handover to the ledger team easier.

@newhoggy newhoggy force-pushed the newhoggy/follow-ledger-naming branch from d769a31 to 4c196b6 Compare July 19, 2023 14:26
@newhoggy newhoggy force-pushed the newhoggy/follow-ledger-naming branch from 4c196b6 to 42b21eb Compare July 19, 2023 14:59
@newhoggy newhoggy enabled auto-merge July 19, 2023 15:05
@newhoggy
Copy link
Collaborator Author

Will look at how the ledger types can be used directly (possible re-exported?) in a future PR.

@newhoggy newhoggy added this pull request to the merge queue Jul 19, 2023
Merged via the queue into main with commit 0a4750e Jul 19, 2023
17 checks passed
@newhoggy newhoggy deleted the newhoggy/follow-ledger-naming branch July 19, 2023 15:32
newhoggy added a commit that referenced this pull request Mar 11, 2024
…dering-in-renderEraBasedGovernanceCmd

Fix command rendering in `renderEraBasedGovernanceCmd`
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.

3 participants