crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-29 06:35:48 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Add script to install post-commit hook, mention in devguide

Browse source
This commit is contained in:
Paul Romano 2021-08-11 13:45:29 -05:00
parent 41c66166e9
commit 664b106f64
5 changed files with 103 additions and 99 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -67,6 +67,11 @@ features and bug fixes. The general steps for contributing are as follows:
cd openmc
git checkout -b newbranch develop
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.
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,
ensure that those changes are made on a different branch.