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

Consistent naming for stake-pool command related types, functions and modules #246

Conversation

newhoggy
Copy link
Contributor

@newhoggy newhoggy commented Sep 5, 2023

Changelog

- description: |
    Consistent naming for `stake-pool` command related types, functions and modules
# uncomment types applicable to the change:
  type:
  # - feature        # introduces a new feature
  # - breaking       # the API has changed in a breaking way
  - compatible     # the API has changed but is non-breaking
  # - optimisation   # measurable performance improvements
  - improvement    # QoL changes e.g. refactoring
  # - bugfix         # fixes a defect
  # - test           # fixes/modifies tests
  # - maintenance    # not directly related to the code
  # - release        # related to a new release preparation
  # - documentation  # change in code docs, haddocks...

Context

There are inconsistencies in the naming of type functions and modules related to the stake-pool commands. Sometimes, the word "stake" is omitted, sometimes not. Sometimes the word "Cert" is used instead of "Certificate". Sometimes the "Cmd" suffix is used and sometimes not. And so forth.

This PR renames all these things to follow exactly how the command it implements is named.

This PR also drops Shelley prefix for such names because everything is basically in the Shelley based era, so the distinction isn't necessary.

No CLI commands API changes are introduced in this PR.

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
    • round trip tests
    • integration tests
      See Running tests for more details
  • 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

@newhoggy newhoggy marked this pull request as ready for review September 5, 2023 11:38
@newhoggy newhoggy force-pushed the newhoggy/consistent-naming-for-stake-pool-command-related-types-functions-and-modules branch 2 times, most recently from 5461cf9 to 096dcf8 Compare September 6, 2023 23:13
@newhoggy newhoggy force-pushed the newhoggy/consistent-naming-for-stake-pool-command-related-types-functions-and-modules branch from 096dcf8 to e2845e2 Compare September 8, 2023 05:02
@newhoggy newhoggy added this pull request to the merge queue Sep 8, 2023
Merged via the queue into main with commit eed054e Sep 8, 2023
19 checks passed
@newhoggy newhoggy deleted the newhoggy/consistent-naming-for-stake-pool-command-related-types-functions-and-modules branch September 8, 2023 05:37
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.

2 participants