You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We use pre-commit to make sure the code is consistently formatted. To make sure that pre-commit is run every time you commit changes, simply run `pre-commit install`
48
-
49
-
To build the codeflare-sdk pre-commit image run `podman build -f .github/build/Containerfile .` from the root directory.
50
-
51
-
### Testing
52
-
53
-
- To install codeflare-sdk in editable mode, run `pip install -e .` from the repo root.
54
-
- Any new test functions/scripts can be added into the `tests` folder
55
-
- NOTE: Functional tests coming soon, will live in `tests/func_test.py`
56
-
57
-
#### Unit Testing
58
-
- To run the unit tests, run `pytest -v tests/unit_test.py`
59
-
60
-
#### Local e2e Testing
61
-
- Please follow the [e2e documentation](https://github.com/project-codeflare/codeflare-sdk/blob/main/docs/e2e.md)
62
-
63
-
#### Code Coverage
64
-
65
-
- Run tests with the following command: `coverage run -m --source=src pytest tests/unit_test.py`
66
-
- To then view a code coverage report w/ missing lines, run `coverage report -m`
67
-
68
-
### Code Formatting
69
-
70
-
- To check file formatting, in top-level dir run `black --check .`
71
-
- To auto-reformat all files, remove the `--check` flag
72
-
- To reformat an individual file, run `black <filename>`
73
-
74
-
### Package Build
75
-
76
-
To build the python package: `$ poetry build`
22
+
Please see our [CONTRIBUTING.md](./CONTRIBUTING.md) for detailed instructions.
0 commit comments