Skip to content

Commit

Permalink
add contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bonedaddy authored Aug 10, 2020
1 parent 6c5c369 commit 55457fe
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Contribution Guidelines

# Main Rules

* All code must have unit tests written with `cmocka`
* All code must pass valgrind testing with `ctest -T memcheck`
* All code must be formatted with `make format`
* All newly written typedefs, global variables, function declarations, etc.. must having valid doxygen comments

# Memory Allocations

* Where possible conduct memory allocations outside of mutex locks
* This helps minimize the time spend in a lock, thus minimizing the time we block other threads

# Braces


You must always have the opening brace on the same line of the expression.

For example the following is acceptable

```C
if (abc == true) {
/* do stuff */
}
```

Whereas the following is not acceptable:

```C
if (abc == true)
{
/* do stuff */
}
```

0 comments on commit 55457fe

Please sign in to comment.