Skip to content

Commit dbcc028

Browse files
authored
Merge pull request #4 from LonghornRacingElectric/gemini-code-review
2 parents bd40fae + 4e72240 commit dbcc028

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

.gemini/styleguide.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Style Guide
2+
3+
This document outlines the style guide for the monorepo. It includes conventions for code formatting, naming, and documentation to ensure consistency and readability across the codebase.
4+
5+
## Code Formatting
6+
7+
- Use 2 spaces for indentation.
8+
- Keep lines no longer than 100 characters.
9+
10+
## Naming Conventions
11+
12+
- Generally, use camelCase for variable and function names.
13+
- In C, use snake_case for function names.
14+
- Use PascalCase for class names.
15+
- Use UPPER_SNAKE_CASE for constants.
16+
17+
## Documentation
18+
19+
- Include examples in documentation where applicable.
20+
- All top-level folders that define a module/library should have a README.md file.
21+
- It should define how to use the module/library and provide information on building the code.

0 commit comments

Comments
 (0)