Skip to content

Commit 20d397e

Browse files
authored
Update agent guide: clarify variable naming and source file header requirements. (asfernandes#35)
1 parent fa873f9 commit 20d397e

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
- Classes names uses PascalCase.
55
- Method names uses camelCase.
66
- Variable names uses camelCase.
7+
- Do not use variables names starting or ending with underline.
78
- When using statements like `if`, `for`, `while`, etc, if the condition plus the sub-statement takes more than two
89
lines, then the sub-statement should use braces. Otherwise, braces should be avoided.
910
- A C++ source file should be formatted with `clang-format`.
@@ -14,6 +15,7 @@
1415
{ // scope
1516
}
1617
```
18+
- 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.
1719
1820
### Build
1921
- If .cpp files are added, it's necessary to run `cmake --preset default` from the repo root.

0 commit comments

Comments
 (0)