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

Plural for command groups #151

Merged
merged 10 commits into from
Aug 8, 2023
Merged

Conversation

newhoggy
Copy link
Contributor

@newhoggy newhoggy commented Aug 7, 2023

Changelog

- description: |
    Plural for command groups
# 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

This renames command groups to have the Cmds suffix. This is to distinguish them from commands which will have the singular Cmd suffix representing one command.

The change also renames GovernanceCmd' constructor to GovernanceCmds doing away with the apostrophe.

The aim is to introduce consistency in the code to make it easier to maintain with growing complexity in requirements.

No golden files were changed indicating the CLI interface is unchanged.

This is one of the changes picked from #148, but applied across all command groups rather than just the transaction command group.

The change is mechanical and grouped into one PR to make it easy to follow.

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 August 7, 2023 15:48
@newhoggy newhoggy added this pull request to the merge queue Aug 7, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Aug 8, 2023
@newhoggy newhoggy added this pull request to the merge queue Aug 8, 2023
Merged via the queue into main with commit 50ac852 Aug 8, 2023
@newhoggy newhoggy deleted the newhoggy/plural-for-command-groups branch August 8, 2023 05:55
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