Conversation
Document the expected commit structure, incremental PR strategy, and deferred mutability approach for new controller contributions. Update scaffolding docs to separate the scaffolding and generated code commits.
Ensure a tracking issue exists before submitting a bug fix PR, so it can be referenced in commit messages, changelogs, and future discussions.
winiciusallan
left a comment
winiciusallan
left a comment
Member
There was a problem hiding this comment.
I totally agree with the issue thing. Besides, I'd like to suggest two more things:
- AI guidelines if we want to have one (this helps to define the way we handle AI-generated code and avoid slop);
- Add to our review skill to "checkbox" these points.
| Always structure new controller branches as multi-commit, separating generated | ||
| code from hand-written code: | ||
|
|
||
| 1. **Scaffolding commit**: Raw output of `go run ./cmd/scaffold-controller`. |
Member
There was a problem hiding this comment.
Is it worth adding an example commit?
| - **Multiple reconcilers**: `internal/controllers/trunk/` - `updateResource` + `reconcileSubports` + tags | ||
| - **Complex**: `internal/controllers/server/` - Multiple dependencies, many reconcilers | ||
|
|
||
| ## Contributing New Controllers |
Member
There was a problem hiding this comment.
I think we can reference this same section from CONTRIBUTING.md, making this file shorter.
This branch has not been deployed
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
2 participants
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.
Document the expected commit structure, incremental PR strategy, and deferred mutability approach for new controller contributions. Update scaffolding docs to separate the scaffolding and generated code commits.