File tree Expand file tree Collapse file tree 1 file changed +20
-1
lines changed Expand file tree Collapse file tree 1 file changed +20
-1
lines changed Original file line number Diff line number Diff line change 1111Contributing
1212------------
1313
14- This section will be expanded later. For now it lists docstrings for a number of internal variables, classes and functions.
14+ This section will be expanded later. For now it tells you how to get setup to
15+ run the tests and lists docstrings for a number of internal variables, classes
16+ and functions.
17+
18+ Running the tests
19+ ~~~~~~~~~~~~~~~~~
20+
21+ The simplest way is using conda/mamba (same as in the CI). Create yourself a
22+ conda/mamba environment (e.g. ``mamba create -f ci/environment.yml ``).
23+ Activate your environment. Next install the local version of ``cf-xarray ``,
24+ ``python -m pip install --no-deps -e . ``. Now you are ready to run the tests
25+ with ``pytest ``.
26+
27+ Pre-commit
28+ ~~~~~~~~~~
29+
30+ If you want the pre-commit hook too, after installing your environment as
31+ above, simply install pre-commit (``pip install pre-commit ``) and then run
32+ ``pre-commit install ``. Now each time you commit you'll get the pre-commit
33+ checks for free.
1534
1635Variables
1736~~~~~~~~~
You can’t perform that action at this time.
0 commit comments