KAIZEN: add comments explaining the developers' intent.#293
Merged
Conversation
satoru-takeuchi
force-pushed
the
add-technical-note
branch
from
9b73c60 to
a701ecf
Compare
There was a problem hiding this comment.
Pull request overview
This PR is a KAIZEN-style update that adds intent-revealing comments across the controller, scripts, and CRD/API documentation to clarify why certain behaviors/fields exist and how they’re expected to be used.
Changes:
- Documented why
export-diffwrites to a temp file before renaming (restart/interruption detection). - Documented the rationale for the export-data PVC size margin and lower bound.
- Expanded
transferPartSizefield documentation to explain why some jobs read it fromstatusinstead of controller flags.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| internal/controller/script/job-export.sh | Adds comments explaining the temp-file-then-rename pattern for export-diff outputs. |
| internal/controller/mantlebackup_controller.go | Adds comments explaining PVC sizing margin and minimum size rationale. |
| config/crd/bases/mantle.cybozu.io_mantlebackups.yaml | Expands CRD field description for transferPartSize to capture operational intent. |
| charts/mantle-cluster-wide/templates/mantle.cybozu.io_mantlebackups.yaml | Mirrors the CRD description change in the Helm chart template. |
| api/v1/mantlebackup_types.go | Expands Go API field comments for TransferPartSize with the same intent explanation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
Author
|
@skoya76 I got some suggestions from copilot. Please wait until I address these. |
Signed-off-by: Satoru Takeuchi <satoru.takeuchi@gmail.com>
satoru-takeuchi
force-pushed
the
add-technical-note
branch
from
a701ecf to
005beef
Compare
Contributor
Author
|
@skoya76 I addressed Copilot's suggestions. Please review this PR. |
skoya76
approved these changes
Jun 11, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.