2018-08-08 10:16:18 +00:00
|
|
|
<!-- Thank you for contributing to osquery! -->
|
|
|
|
|
|
|
|
|
|
To submit a PR please make sure to follow the next steps:
|
|
|
|
|
|
|
|
|
|
- [ ] Read the `CONTRIBUTING.md` guide on the root of the repo.
|
2020-01-29 18:09:06 +00:00
|
|
|
- [ ] Ensure the code is formatted building the `format_check` target,
|
|
|
|
|
if not move the committed files to the stage area,
|
|
|
|
|
build the `format` target to format, then re-commit.
|
|
|
|
|
More information is available on the wiki.
|
2018-08-08 10:16:18 +00:00
|
|
|
- [ ] Ensure your PR contains a single logical change.
|
|
|
|
|
- [ ] Ensure your PR contains tests for the changes you're submitting.
|
|
|
|
|
- [ ] Describe your changes with as much detail as you can.
|
|
|
|
|
- [ ] Link any issues this PR is related to.
|
|
|
|
|
- [ ] Remove the text above.
|
2019-11-19 04:44:34 +00:00
|
|
|
|
|
|
|
|
<!--
|
|
|
|
|
|
|
|
|
|
The PR will be reviewed by an osquery committer.
|
|
|
|
|
Here are some common things we look for:
|
|
|
|
|
|
|
|
|
|
- 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.
|
|
|
|
|
|
|
|
|
|
-->
|
