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: add documentation about depinject and app wiring #13683

Merged
merged 40 commits into from
Nov 7, 2022

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Oct 28, 2022

Description

Closes: #12633

app (building-apps/...)

  • explain about app wiring, concepts, use case, etc.. (linking to ADR)
  • explain how to configure app.go (short explanation of the changes, linking to tutorials otherwise)
  • explain how to configure app_config.go and as alternative app.yaml

modules (building-modules/depinject)

  • explain how to create module.proto
  • explain what to add in module.go

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)

@codecov
Copy link

codecov bot commented Oct 31, 2022

Codecov Report

Merging #13683 (85c2be6) into main (6ae5641) will decrease coverage by 1.84%.
The diff coverage is 0.00%.

❗ Current head 85c2be6 differs from pull request most recent head 6993169. Consider uploading reports for the commit 6993169 to get more accurate results

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #13683      +/-   ##
==========================================
- Coverage   56.66%   54.81%   -1.85%     
==========================================
  Files         636      647      +11     
  Lines       54552    55798    +1246     
==========================================
- Hits        30911    30588     -323     
- Misses      21134    22722    +1588     
+ Partials     2507     2488      -19     
Impacted Files Coverage Δ
x/group/module/module.go 52.50% <0.00%> (ø)
x/distribution/client/cli/query.go 0.00% <0.00%> (-73.95%) ⬇️
x/distribution/client/cli/tx.go 5.49% <0.00%> (-69.79%) ⬇️
x/gov/client/cli/tx.go 13.94% <0.00%> (-56.58%) ⬇️
x/gov/client/cli/query.go 0.00% <0.00%> (-35.33%) ⬇️
x/distribution/simulation/operations.go 80.64% <0.00%> (-9.68%) ⬇️
x/gov/client/cli/util.go 86.15% <0.00%> (-9.24%) ⬇️
x/bank/types/params.go 84.48% <0.00%> (-7.41%) ⬇️
x/evidence/client/cli/query.go 76.19% <0.00%> (-3.12%) ⬇️
x/auth/module.go 54.05% <0.00%> (-3.09%) ⬇️
... and 54 more

@github-actions github-actions bot removed the C:x/group label Nov 1, 2022
@julienrbrt julienrbrt marked this pull request as ready for review November 1, 2022 15:44
@julienrbrt julienrbrt requested a review from a team as a code owner November 1, 2022 15:44
@julienrbrt julienrbrt enabled auto-merge (squash) November 4, 2022 16:36
Copy link
Contributor

@samricotta samricotta left a comment

Choose a reason for hiding this comment

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

lgtm, just need to rebase. Might need another set of eyes that have more context to complete the approval process

Copy link
Member

@kocubinski kocubinski left a comment

Choose a reason for hiding this comment

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

Looks awesome, thank you for making these doc updates! Just some minor nits.

depinject/README.md Show resolved Hide resolved
docs/docs/building-apps/00-app-go.md Outdated Show resolved Hide resolved
docs/docs/building-modules/14-depinject.md Outdated Show resolved Hide resolved
docs/docs/building-modules/14-depinject.md Outdated Show resolved Hide resolved
docs/docs/building-modules/14-depinject.md Outdated Show resolved Hide resolved
docs/docs/building-modules/14-depinject.md Outdated Show resolved Hide resolved
depinject/README.md Outdated Show resolved Hide resolved
docs/docs/building-modules/14-depinject.md Outdated Show resolved Hide resolved
docs/docs/building-modules/14-depinject.md Show resolved Hide resolved
Co-authored-by: Facundo Medica <14063057+facundomedica@users.noreply.github.com>
@julienrbrt julienrbrt disabled auto-merge November 7, 2022 19:12
@julienrbrt julienrbrt enabled auto-merge (squash) November 7, 2022 19:17
@julienrbrt julienrbrt merged commit c85447c into main Nov 7, 2022
@julienrbrt julienrbrt deleted the julien/depinject branch November 7, 2022 19:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create 'An introduction to depinject' tutorial
8 participants