AGENTS.md draft - #353
Conversation
|
we should add some workflow specifics like:
|
MariusBgm
left a comment
MariusBgm
left a comment
There was a problem hiding this comment.
LGTM! some more clarification on the tests.
maybe run it through an llm to clean up the wording and orthography (e.g. the c++ stuff lacks periods)
|
@KonradBreitsprecherBkd can i make some changes on this branch directly? |
|
@KonradBreitsprecherBkd i added some details: definition of done, reviewing guardrails, build instructions (save some overheads), and fixed orthography. |
|
Scanned over the last commits quickly, looks good. |
Signed-off-by: Konrad Breitsprecher <Konrad.Breitsprecher@vector.com>
Signed-off-by: Marius Börschig <Marius.Boerschig@vector.com>
Signed-off-by: Konrad Breitsprecher <Konrad.Breitsprecher@vector.com>
Co-authored-by: Marius Börschig <marius.boerschig@vector.com> Signed-off-by: Marius Börschig <marius.boerschig@vector.com>
Signed-off-by: Marius Börschig <Marius.Boerschig@vector.com>
refine reviewing rules Signed-off-by: Marius Börschig <Marius.Boerschig@vector.com>
d6acc11 to
6838cba
Compare
…ructions YOLO mode Signed-off-by: Marius Börschig <Marius.Boerschig@vector.com>
MariusBgm
left a comment
MariusBgm
left a comment
There was a problem hiding this comment.
looks a bit verbose but i think we need some of those guard rails. Some information (like c++ coding conventions) is implicitly given in the team, so it's finally good to have them documented somewhere.
| internal headers. Include ordering is deliberately unenforced (`SortIncludes: false`) — do not reorder. | ||
| - Public API needs doxygen: `/*!` blocks with `\brief`, `\param`, `\ref`, and `//!<` for fields. Not `///`, | ||
| not `@brief`. | ||
| - Always run clang-format. It enforces 120 columns, 4-space indent, Allman braces except after `namespace`, |
There was a problem hiding this comment.
my agent seems to have used the wrong clang-format version and produced warnings on the CI. maybe we should relax this requirement
|
I had another though on the AGENTS.md. We have two user groups for it: Us developers extending the SIL Kit itself, and the actual users that integrate the lib, write a demo or even more abstract, use the already integrated SIL Kit in antoher tool. These would need different AI instructions. Not sure how to split this though. Package SIL Kit with an AGENTS.md different from this one would be a start. |
i have had success with defining different personaes. say we have a developer persona and a user persona. i'll give it a shot. and maybe i can trim it a bit, as it gets quite verbose |
…ld instructions ensure agents.md is reusable by users, skip clang-format Signed-off-by: Marius Börschig <Marius.Boerschig@vector.com>
2 participants
No description provided.