Fix Typo in provider-http DisposableRequest Resource #17
Conversation
Signed-off-by: arielsepton <[email protected]>
Signed-off-by: arielsepton <[email protected]>
fix: Correct typo in DisposableRequest
There was a problem hiding this comment.
Cool @arielsepton, thanks for making this update! It looks like a thorough case sensitive find/replace that updates all desposable --> disposable. I expect this to get the job done there.
To be clear, even though this is a typo correction, it is still a breaking change to the DesposibleRequest API, as it is essentially being removed entirely and being replaced with a new DisposibleRequest API. Given the alpha version and the overall early maturity and adoption of this provider, I would expect that to be a reasonable change still at this point, but going forward as we mature this API we will not have that luxury in the future. So, something to be aware of.
When this is merged, you should cut a new release and include release notes explaining the impact of this change, e.g. with a # Breaking Changes section in the release notes. If you have any guidance for how people can migrate to using the new type, if they have already used the previous type, would also be helpful for the adopters 🙇♂️
|
It's also a good idea to get into the habit of having detailed PR descriptions that explain the changes in the PR, how they are tested, etc. I think the PR template in this repo has some structure around that, so get in the habit of filling it out thoroughly to communicate your changes effectively. |
Signed-off-by: arielsepton <[email protected]>
No description provided.