ratify icon indicating copy to clipboard operation
ratify copied to clipboard

docs: Create BREAKING_CHANGE_AND_DEPRECATION.md

Open susanshi opened this issue 10 months ago • 2 comments

Description

What this PR does / why we need it:

document process for breaking change and deprecation

Which issue(s) this PR fixes (optional, using fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when the PR gets merged):

Fixes #

Type of change

Please delete options that are not relevant.

  • [ ] Bug fix (non-breaking change which fixes an issue)
  • [ ] New feature (non-breaking change which adds functionality)
  • [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • [ ] Helm Chart Change (any edit/addition/update that is necessary for changes merged to the main branch)
  • [ ] This change requires a documentation update

Checklist:

  • [ ] Does the affected code have corresponding tests?
  • [ ] Are the changes documented, not just with inline documentation, but also with conceptual documentation such as an overview of a new feature, or task-based documentation like a tutorial? Consider if this change should be announced on your project blog.
  • [ ] Does this introduce breaking changes that would require an announcement or bumping the major version?
  • [ ] Do all new files have appropriate license header?

Post Merge Requirements

  • [ ] MAINTAINERS: manually trigger the "Publish Package" workflow after merging any PR that indicates Helm Chart Change

susanshi avatar Apr 17 '24 04:04 susanshi

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 68.16%. Comparing base (1bd347c) to head (bb3e9cf). Report is 16 commits behind head on dev.

Additional details and impacted files
@@            Coverage Diff             @@
##              dev    #1399      +/-   ##
==========================================
+ Coverage   66.76%   68.16%   +1.39%     
==========================================
  Files         116      119       +3     
  Lines        6030     6134     +104     
==========================================
+ Hits         4026     4181     +155     
+ Misses       1620     1559      -61     
- Partials      384      394      +10     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Apr 17 '24 04:04 codecov[bot]

lgtm, thanks for adding the doc!

binbin-li avatar May 06 '24 08:05 binbin-li