Skip to content

Commit 4337646

Browse files
committed
Update README.md to point to the new CONTRIBUTING.md
1 parent 653cf2c commit 4337646

File tree

1 file changed

+2
-56
lines changed

1 file changed

+2
-56
lines changed

README.md

+2-56
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Codeflare-SDK
1+
# CodeFlare SDK
22

33
[![Python application](https://github.com/project-codeflare/codeflare-sdk/actions/workflows/unit-tests.yml/badge.svg?branch=main)](https://github.com/project-codeflare/codeflare-sdk/actions/workflows/unit-tests.yml)
44
![coverage badge](./coverage.svg)
@@ -19,61 +19,7 @@ Can be installed via `pip`: `pip install codeflare-sdk`
1919

2020
## Development
2121

22-
### Prerequisites
23-
24-
We recommend using Python 3.9 for development, along with Poetry.
25-
Create a Poetry virtual environment with the required Python version 3.9, and run all commands within this environment.
26-
27-
- run: `poetry shell`
28-
29-
#### Install dependencies:
30-
31-
- run: `poetry install`
32-
33-
This will install standard requirements as specified in the poetry.lock file. Test and docs dependencies are optional.
34-
35-
- To include test dependencies run: `poetry install --with test`
36-
37-
- To include docs dependencies run: `poetry install --with docs`
38-
39-
- To include test and docs dependencies run: `poetry install --with test,docs`
40-
41-
If you require a requirements.txt file you can run:
42-
43-
`poetry export -f requirements.txt --output requirements.txt --without-hashes`
44-
45-
### Pre-commit
46-
47-
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.
7723

7824
## Release Instructions
7925

0 commit comments

Comments
 (0)