[WIP] feat: add AGENTS.md and CLAUDE.md#3149
[WIP] feat: add AGENTS.md and CLAUDE.md#3149csviri wants to merge 1 commit intooperator-framework:mainfrom
Conversation
openshift-ci
bot
added
the
do-not-merge/work-in-progress
|
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. |
csviri
changed the title
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 |
|
|
||
| ### Integration Tests | ||
|
|
||
| - Use `LocallyRunOperatorExtension` or `OperatorExtension` from `operator-framework-junit5` |
There was a problem hiding this comment.
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.
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.
Should use conventional commit messages
|
@metacosm I did not have the time to get back on this properly yes, next week will do so. |
2 participants
Signed-off-by: Attila Mészáros a_meszaros@apple.com