Skip to content

Update agent guide: clarify variable naming and source file header requirements. #35

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.

Sign up for GitHub

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

Merged
asfernandes merged 1 commit into from
Feb 23, 2026
Merged

Update agent guide: clarify variable naming and source file header requirements. #35

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
- Classes names uses PascalCase.
- Method names uses camelCase.
- Variable names uses camelCase.
- Do not use variables names starting or ending with underline.
- When using statements like `if`, `for`, `while`, etc, if the condition plus the sub-statement takes more than two
lines, then the sub-statement should use braces. Otherwise, braces should be avoided.
- A C++ source file should be formatted with `clang-format`.
Expand All @@ -14,6 +15,7 @@
{ // scope
}
```
- When adding new source files, copy the header from the existing files, but update the Copyright line to reflect the current year and use `$(git config --get user.name)` as the original author.

### Build
- If .cpp files are added, it's necessary to run `cmake --preset default` from the repo root.
Expand Down