Skip to content

Commit

Permalink
CONTRIBUTING: small style tweak
Browse files Browse the repository at this point in the history
  • Loading branch information
ken-matsui authored Nov 24, 2024
1 parent bca4bbd commit 8ce5582
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,22 @@ Consistency is key to maintaining a clean and readable codebase. As stated in th
Please follow this principle to ensure the code remains cohesive and easy to
navigate.

(*Under Construction) Additionally, be mindful of when to use structs vs. classes. For guidance,
refer to the [Google C++ Style Guide: Structs vs. Classes](https://google.github.io/styleguide/cppguide.html#Structs_vs._Classes).
### Naming Conventions (*Under Construction)

The project's naming conventions are specified in the
[.clang-tidy](.clang-tidy) file. Here's a brief summary:

- **Files/Directories**: `PascalCase`
- **Types/Classes**: `PascalCase`
- **Variables**: `snake_case`
- **Member Variables**: `snake_case_`
- **Functions**: `camelCase`
- **Methods**: `camelCase_`

(Note: Variables use `snake_case` since they tend to be shorter than functions.)

Be mindful of when to use structs vs. classes. For guidance, refer to the
[Google C++ Style Guide: Structs vs. Classes](https://google.github.io/styleguide/cppguide.html#Structs_vs._Classes).

### Formatting and Linting

Expand Down Expand Up @@ -64,20 +78,6 @@ break existing functionality:
poac test # or make test
```

### Naming Conventions (*Under Construction)

The project's naming conventions are specified in the
[.clang-tidy](.clang-tidy) file. Here's a brief summary:

- **Files/Directories**: `PascalCase`
- **Types/Classes**: `PascalCase`
- **Variables**: `snake_case`
- **Member Variables**: `snake_case_`
- **Functions**: `camelCase`
- **Methods**: `camelCase_`

(Note: Variables use `snake_case` since they tend to be shorter than functions.)

## Commit Message

We generally follow the
Expand Down

0 comments on commit 8ce5582

Please sign in to comment.