crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-28 14:15:42 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Mention that clang-format needs to be installed

Browse source
This commit is contained in:
Paul Romano 2021-08-13 09:09:55 -05:00
parent 664b106f64
commit f1992db5e2
2 changed files with 5 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

3
docs/source/devguide/styleguide.rst
View file

@ -22,7 +22,8 @@ To ensure consistent styling with little effort, this project uses `clang-format
``.clang-format`` file that can be used to automatically apply a consistent
format. The easiest way to use clang-format is to run
``tools/dev/install-commit-hooks.sh`` to install a post-commit hook that gets
executed each time a commit is made. In addition, you may want to configure your
executed each time a commit is made. Note that this script requires that you
already have clang-format installed. In addition, you may want to configure your
editor/IDE to automatically runs clang-format using the ``.clang-format`` file
whenever a file is saved. For example, `Visual Studio Code
<https://code.visualstudio.com/docs/cpp/cpp-ide#_code-formatting>`_ includes

5
docs/source/devguide/workflow.rst
View file

@ -69,8 +69,9 @@ features and bug fixes. The general steps for contributing are as follows:
3. Run ``tools/dev/install-commit-hooks.sh`` to install a post-commit hook that
runs clang-format on C++ files to apply :ref:`automatic code formatting
<styleguide_formatting>`. In addition, you may want to configure your text
editor to automatically run clang-format when saving C++ files.
<styleguide_formatting>` (requires that clang-format already be installed).
In addition, you may want to configure your text editor to automatically run
clang-format when saving C++ files.
3. Make your changes on the new branch that you intend to have included in
*develop*. If you have made other changes that should not be merged back,