Skip to content

Commit ca001f6

Browse files
authored
contrib : add naming guidelines (cont) (#11177)
1 parent 00b4c3d commit ca001f6

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
- Avoid fancy-looking modern STL constructs, use basic `for` loops, avoid templates, keep it simple
2323
- Vertical alignment makes things more readable and easier to batch edit
2424
- Clean-up any trailing whitespaces, use 4 spaces for indentation, brackets on the same line, `void * ptr`, `int & a`
25-
- Use sized integer types in the public API
25+
- Use sized integer types such as `int32_t` in the public API, e.g. `size_t` may also be appropriate for allocation sizes or byte offsets
2626
- Declare structs with `struct foo {}` instead of `typedef struct foo {} foo`
2727
- In C++ code omit optional `struct` and `enum` keyword whenever they are not necessary
2828
```cpp
@@ -115,7 +115,7 @@
115115
# Documentation
116116
117117
- Documentation is a community effort
118-
- When you need to look into the source code to figure out implementation details to figure out how to use an API consider adding a short summary to the header file for future reference
118+
- When you need to look into the source code to figure out how to use an API consider adding a short summary to the header file for future reference
119119
- When you notice incorrect or outdated documentation, please update it
120120
121121
# Resources

0 commit comments

Comments
 (0)