Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Guard missed test and document how to style #1210

Merged
merged 4 commits into from
Aug 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion examples/simple_conduction/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ blt_add_executable( NAME simple_conduction_without_input_file
OUTPUT_DIR ${EXAMPLE_OUTPUT_DIRECTORY}
DEPENDS_ON serac_physics serac_mesh serac_functional
)
if(ENABLE_TESTS)

if(SERAC_ENABLE_TESTS)
blt_add_test(NAME simple_conduction_without_input_file
COMMAND simple_conduction_without_input_file
NUM_MPI_TASKS 1 )
Expand Down
18 changes: 18 additions & 0 deletions src/docs/sphinx/dev_guide/style_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,24 @@ to one of ``A``'s instance variables ``Foo f``, ``B`` should store a non-owning
either ``Foo&`` or ``Foo*``. This should be ``const`` if at all possible. In this case, shared ownership
is not required because the lifetime of ``B`` is entirely dependent on the lifetime of ``A``.

How to style your code
----------------------

We have two methods of enabling styling your code via ClangFormat.

The first method is to use the `style` build target on a configuration with the correct version of
ClangFormat enabled. Here is an example on how to do it on LC's Ruby machine:

.. code-block:: bash

$ ./config-build.py host-configs/[email protected]
$ cd [email protected]
$ make style

The second method is to make a comment of ``/style`` on your open GitHub pull request. This will trigger
a GitHub Action that will automatically style your code and commit it to your branch. You will need to
`git pull` after it is finished to continue to work on that branch.
Comment on lines +49 to +51
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Who is allowed to make use of this /style command?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Definitely anyone who has write access to our repo can trigger it. I would need to try what happens if someone outside our organization does it. They certainly cannot change the behavior or the GitHub Action.


Documentation
-------------

Expand Down