From ff6c7f4e71775c8cede7e25a304d68b00a45d8ee Mon Sep 17 00:00:00 2001 From: James Zern Date: Tue, 30 May 2023 12:23:04 -0700 Subject: [PATCH] CONTRIBUTING.md: add C style / cmake-format notes Change-Id: I54ad0e27341025a6385a736d5a79ab8b6556a6ec --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 330b38f6..9540f34f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -60,6 +60,18 @@ See the [WebM Project page](https://www.webmproject.org/code/contribute/submitting-patches/) for additional details. +## Code Style + +The C code style is based on the +[Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html) and +`clang-format --style=Google`, though this project doesn't use the tool to +enforce the formatting. + +CMake files are formatted with +[cmake-format](https://cmake-format.readthedocs.io/en/latest/). `cmake-format +-i` can be used to format individual files, it will use the settings from +`.cmake-format.py`. + ## Community Guidelines This project follows