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

refactor: rename container.Option to container.Config #12021

Merged
merged 2 commits into from
May 24, 2022

Conversation

kocubinski
Copy link
Member

@kocubinski kocubinski commented May 23, 2022

Description

Ref: #11917

The noun should be one which conveys the notion of a core instruction. Other names for this type I've considered:

  • Instruction
  • Behavior
  • Specification
  • Config (probably the most straighforward)
  • Trait

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)

@github-actions github-actions bot added the C:depinject Issues and PR related to depinject label May 23, 2022
@kocubinski kocubinski force-pushed the kocubinski/container-option branch from 91c78f9 to dbbe9d3 Compare May 23, 2022 19:57
@codecov
Copy link

codecov bot commented May 23, 2022

Codecov Report

Merging #12021 (3aa815b) into main (27869a5) will increase coverage by 0.32%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #12021      +/-   ##
==========================================
+ Coverage   66.09%   66.42%   +0.32%     
==========================================
  Files         671      685      +14     
  Lines       70950    71925     +975     
==========================================
+ Hits        46894    47774     +880     
- Misses      21399    21467      +68     
- Partials     2657     2684      +27     
Impacted Files Coverage Δ
container/build.go 76.00% <100.00%> (ø)
container/config.go 93.18% <100.00%> (ø)
container/location.go 73.58% <0.00%> (ø)
container/module_dep.go 100.00% <0.00%> (ø)
container/debug.go 93.60% <0.00%> (ø)
container/container.go 89.60% <0.00%> (ø)
container/group.go 83.72% <0.00%> (ø)
container/one_per_module.go 76.00% <0.00%> (ø)
... and 6 more

@kocubinski kocubinski marked this pull request as ready for review May 23, 2022 20:50
@kocubinski kocubinski requested a review from a team as a code owner May 23, 2022 20:50
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.

Trait doesn't seem clearer to me than Option. For lack of anything I've seen that's better I'd say let's go with Config. At least it's better than Option and not otherwise confusing (I think)

CHANGELOG.md Outdated Show resolved Hide resolved
@kocubinski kocubinski force-pushed the kocubinski/container-option branch from dc648cf to b5a2139 Compare May 23, 2022 21:15
@kocubinski kocubinski changed the title refactor: rename container.Option to container.Trait refactor: rename container.Option to container.Config May 23, 2022
CHANGELOG.md Outdated Show resolved Hide resolved
@aaronc
Copy link
Member

aaronc commented May 23, 2022

Also no need to rebase, we always squash anyways

@aaronc
Copy link
Member

aaronc commented May 23, 2022

@kocubinski once you have two approvals and you're ready to merge, you can add the auto merge label

@kocubinski kocubinski added the A:automerge Automatically merge PR once all prerequisites pass. label May 24, 2022
@mergify mergify bot merged commit dafdc10 into main May 24, 2022
@mergify mergify bot deleted the kocubinski/container-option branch May 24, 2022 01:19
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. C:depinject Issues and PR related to depinject
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants