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

docs: create autocli documentation #15353

Merged
merged 19 commits into from
Mar 14, 2023
Merged

docs: create autocli documentation #15353

merged 19 commits into from
Mar 14, 2023

Conversation

samricotta
Copy link
Contributor

@samricotta samricotta commented Mar 10, 2023

Closes: #15351

Adds autocli documentation and achieves the following:

  • Add a guide as to how to implement
  • Examples
  • Explanation of the issue it resolves

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@samricotta samricotta requested a review from a team as a code owner March 10, 2023 16:51
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

nice doc! I have left a few comments.

docs/docs/building-modules/09-autocli.md Outdated Show resolved Hide resolved
docs/docs/building-modules/09-autocli.md Outdated Show resolved Hide resolved
docs/docs/building-modules/09-autocli.md Show resolved Hide resolved
docs/docs/building-modules/09-autocli.md Show resolved Hide resolved
docs/docs/building-modules/09-autocli.md Outdated Show resolved Hide resolved
docs/docs/building-modules/09-autocli.md Outdated Show resolved Hide resolved
docs/docs/building-modules/09-autocli.md Outdated Show resolved Hide resolved
docs/docs/building-modules/09-autocli.md Outdated Show resolved Hide resolved
docs/docs/building-modules/09-autocli.md Outdated Show resolved Hide resolved
docs/docs/building-modules/09-autocli.md Show resolved Hide resolved
docs/docs/building-modules/09-autocli.md Outdated Show resolved Hide resolved
docs/docs/building-modules/09-autocli.md Outdated Show resolved Hide resolved
docs/docs/building-modules/09-autocli.md Outdated Show resolved Hide resolved
docs/docs/building-modules/09-autocli.md Outdated Show resolved Hide resolved
docs/docs/building-modules/09-autocli.md Outdated Show resolved Hide resolved
docs/docs/building-modules/09-autocli.md Outdated Show resolved Hide resolved
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

pre-approval, as lgtm! pending some suggestions to add.

docs/docs/building-modules/09-autocli.md Outdated Show resolved Hide resolved
docs/docs/building-modules/09-autocli.md Outdated Show resolved Hide resolved
docs/docs/building-modules/09-autocli.md Outdated Show resolved Hide resolved
Copy link
Member

@aaronc aaronc left a comment

Choose a reason for hiding this comment

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

We should describe how to create positional parameters. That is probably more important than customizing flag names

@julienrbrt julienrbrt added the backport/v0.47.x PR scheduled for inclusion in the v0.47's next stable release label Mar 13, 2023
Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for taking this on

@julienrbrt julienrbrt added the A:automerge Automatically merge PR once all prerequisites pass. label Mar 14, 2023
@mergify mergify bot merged commit 3513c5d into main Mar 14, 2023
@mergify mergify bot deleted the sam/cli-docs branch March 14, 2023 12:14
mergify bot pushed a commit that referenced this pull request Mar 14, 2023
Closes: [#15351 ](#15351)

Adds autocli documentation and achieves the following:

- [x] Add a guide as to how to implement
- [x] Examples
- [x] Explanation of the issue it resolves

---

### Author Checklist

*All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.*

I have...

- [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/main/docs/docs/building-modules)
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [ ] updated the relevant documentation or specification
- [ ] reviewed "Files changed" and left comments if necessary
- [ ] confirmed all CI checks have passed

### Reviewers Checklist

*All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.*

I have...

- [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] confirmed `!` in the type prefix if API or client breaking change
- [ ] confirmed all author checklist items have been addressed
- [ ] reviewed state machine logic
- [ ] reviewed API design and naming
- [ ] reviewed documentation is accurate
- [ ] reviewed tests and test coverage
- [ ] manually tested (if applicable)

(cherry picked from commit 3513c5d)

# Conflicts:
#	docs/docs/building-modules/10-structure.md
julienrbrt added a commit that referenced this pull request Mar 14, 2023
Co-authored-by: samricotta <37125168+samricotta@users.noreply.github.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:automerge Automatically merge PR once all prerequisites pass. backport/v0.47.x PR scheduled for inclusion in the v0.47's next stable release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create documentation for AutoCLI
5 participants