Skip to content

Commit

Permalink
Doc: Pre-Commit Locally (#4741)
Browse files Browse the repository at this point in the history
How to do automatic pre-commit tests locally.
  • Loading branch information
ax3l authored Mar 2, 2024
1 parent 569aa1c commit b0ae812
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions Docs/source/developers/testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,20 @@ For instance, compiling with ``clang++ -Werror`` would be:
export CXXFLAGS="-Werror"
Run Pre-Commit Tests Locally
----------------------------

When proposing code changes to Warpx, we perform a couple of automated stylistic and correctness checks on the code change.
You can run those locally before you push to save some time, install them once like this:

.. code-block:: sh
python -m pip install -U pre-commit
pre-commit install
See `pre-commit.com <https://pre-commit.com>`__ and our ``.pre-commit-config.yaml`` file in the repository for more details.


Run the test suite locally
--------------------------

Expand Down

0 comments on commit b0ae812

Please sign in to comment.