valitydev/osquery-1
14
0
Fork 0
mirror of https://github.com/valitydev/osquery-1.git synced 2024-11-06 09:35:20 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: Add common code-review checks to PR template (#6048)

Browse Source
This commit is contained in:
Teddy Reed 2019-11-18 23:44:34 -05:00 committed by Nick Anderson
parent 2d4308b284
commit e4e95e9e65
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -8,3 +8,21 @@ To submit a PR please make sure to follow the next steps:
- [ ] Describe your changes with as much detail as you can.
- [ ] Link any issues this PR is related to.
- [ ] Remove the text above.
<!--
The PR will be reviewed by an osquery committer.
Here are some common things we look for:
- The code is formatted correctly, considering using `make format_check`.
- Common utilities within `./osquery/utils` are used where appropriate (avoid reinventions).
- Modern C++ structures and patterns are used whenever possible.
- No memory or file descriptor leaks, please check all early-return and destructors.
- No explicit casting, such as `return (int)my_var`, instead use `static_cast`.
- The minimal amount of includes are used, only include what you use.
- Comments for methods, structures, and classes follow our common patterns.
- `Status` and `LOG(N)` messages do not use punctuation or contractions.
- Support for both CMake and BUCK (we are happy to help).
- The code mostly looks and feels similar to the existing codebase.
-->