-
Notifications
You must be signed in to change notification settings - Fork 235
[WIP] feat: add AGENTS.md and CLAUDE.md #3149
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
base: main
Are you sure you want to change the base?
Conversation
|
I'd rather we spend efforts on maintaining documentation for actual users than spending time having to maintain another document for "agents". |
Hi @metacosm , this is WIP, will probably change fundamentally. Those two are not solving the same problem, this is guidline for AI when writing / helping to write code. |
I know what this is for but this looks like documentation and, for all purposes and intents, it is. So that's yet another thing that would need to be updated when we already struggle with the "regular" documentation. |
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
|
|
||
| ### Unit Tests | ||
|
|
||
| - Use JUnit 5 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is false.
|
|
||
| ### Integration Tests | ||
|
|
||
| - Use `LocallyRunOperatorExtension` or `OperatorExtension` from `operator-framework-junit5` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This won't stay true for much longer…
| ### Integration Tests | ||
|
|
||
| - Use `LocallyRunOperatorExtension` or `OperatorExtension` from `operator-framework-junit5` | ||
| - Test against real Kubernetes API (typically via test cluster or mock server) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMO, preferred way should be to use Testcontainers…
| ### PR Guidelines | ||
|
|
||
| - Keep changes focused and atomic | ||
| - Write clear commit messages (imperative mood: "Add feature" not "Added feature") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should use conventional commit messages
|
@metacosm I did not have the time to get back on this properly yes, next week will do so. |
Signed-off-by: Attila Mészáros a_meszaros@apple.com