diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..c828dc66 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,17 @@ + + + + + +## Manually checked properties + + +* [ ] `#ifdef`s only for header encapsulation +* [ ] `api.h` does not include other files +* [ ] No stringification macros +* [ ] Output-parameter pointers in functions are on the left +* [ ] Negative return values on failure of API functions (within restrictions of FO transform). +* [ ] `const` arguments are labeled as `const` +* [ ] (optional) All integer types are of fixed size, using `stdint.h` types (including `uint8_t` instead of `unsigned char`) +* [ ] Integers used for indexing are of size `size_t` +* [ ] variable declarations at the beginning (except in `for (size_t i=...`)