diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 0309148120..68a6e692a4 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -13,7 +13,7 @@ Fixes # (issue) # Checklist - [ ] I have performed a self-review of my own code -- [ ] I have run [clang-format](https://docs.openmc.org/en/latest/devguide/styleguide.html#automatic-formatting) on any C++ source files (if applicable) +- [ ] I have run [clang-format](https://docs.openmc.org/en/latest/devguide/styleguide.html#automatic-formatting) (version 15) on any C++ source files (if applicable) - [ ] I have followed the [style guidelines](https://docs.openmc.org/en/latest/devguide/styleguide.html#python) for Python source files (if applicable) - [ ] I have made corresponding changes to the documentation (if applicable) - [ ] I have added tests that prove my fix is effective or that my feature works (if applicable) diff --git a/docs/source/devguide/styleguide.rst b/docs/source/devguide/styleguide.rst index 2a744b819c..9f6f82f066 100644 --- a/docs/source/devguide/styleguide.rst +++ b/docs/source/devguide/styleguide.rst @@ -29,6 +29,10 @@ whenever a file is saved. For example, `Visual Studio Code `_ includes support for running clang-format. +.. note:: + OpenMC's CI uses `clang-format` version 15. A different version of `clang-format` + may produce different line changes and as a result fail the CI test. + Miscellaneous -------------