chore: Update CONTRIBUTING.md to use uv (#41)

szaher · andreyvelich · web-flow · commit 6709dcff0f3e · 2025-09-09T13:08:36.000Z
* Update CONTRIBUTING.md to use uv Signed-off-by: Saad Zaher <szaher@redhat.com> * remove .flake8 & update .gitignore Signed-off-by: Saad Zaher <szaher@redhat.com> * Fix merge conflict Signed-off-by: Saad Zaher <szaher@redhat.com> * checkout Makefile, pyproject, lock file from main branch Signed-off-by: Saad Zaher <szaher@redhat.com> * update gitignore Signed-off-by: Saad Zaher <szaher@redhat.com> * Update CONTRIBUTING.md Co-authored-by: Andrey Velichkevich <andrey.velichkevich@gmail.com> Signed-off-by: Saad Zaher <szaher@redhat.com> * Add make install & foramt Signed-off-by: Saad Zaher <eng.szaher@gmail.com> * Remove uv pip install dev dependencies as we are moving to `dependency-groups` instead of `optional-dependencies` because pypi.org doesn't support git dependencies we need ot use `uv sync` instead of `uv pip ...` which will automatically sync all default groups (dev is a default group in uv) Signed-off-by: Saad Zaher <szaher@redhat.com> * fix typo in the contributing.md file Signed-off-by: Saad Zaher <szaher@redhat.com> * Update Makefile Signed-off-by: Saad Zaher <szaher@redhat.com> * update structure Signed-off-by: Saad Zaher <szaher@redhat.com> * rephrase uv install Signed-off-by: Saad Zaher <szaher@redhat.com> * update install step at Makefile Signed-off-by: Saad Zaher <szaher@redhat.com> * Update CONTRIBUTING.md Co-authored-by: Andrey Velichkevich <andrey.velichkevich@gmail.com> Signed-off-by: Saad Zaher <szaher@redhat.com> * Apply suggestion from @andreyvelich Co-authored-by: Andrey Velichkevich <andrey.velichkevich@gmail.com> Signed-off-by: Saad Zaher <szaher@redhat.com> * Apply suggestion from @andreyvelich Co-authored-by: Andrey Velichkevich <andrey.velichkevich@gmail.com> Signed-off-by: Saad Zaher <szaher@redhat.com> * update Make target verify to use install Signed-off-by: Saad Zaher <szaher@redhat.com> * fix formatting in contributing guide Signed-off-by: Saad Zaher <szaher@redhat.com> * remove redundant commands Signed-off-by: Saad Zaher <szaher@redhat.com> * use make install-dev instead of make install Signed-off-by: Saad Zaher <szaher@redhat.com> * update install target reference Signed-off-by: Saad Zaher <szaher@redhat.com> * remove group dev from make install-dev target Signed-off-by: Saad Zaher <szaher@redhat.com> * move coding style to dev Signed-off-by: Saad Zaher <szaher@redhat.com> * remove pre-commit stuff from contributing guide Signed-off-by: Saad Zaher <szaher@redhat.com> --------- Signed-off-by: Saad Zaher <szaher@redhat.com> Signed-off-by: Saad Zaher <eng.szaher@gmail.com> Co-authored-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,89 +1,76 @@
 # Contributing to the Kubeflow SDK
 
-Thank you for your interest in contributing to the Kubeflow SDK!
+This guide explains how to contribute to the Kubeflow SDK project.
+For the Kubeflow SDK documentation, please check [the official Kubeflow documentation](https://www.kubeflow.org/docs/components/).
 
-## Getting Started
-
-### Prerequisites
-- Python 3.8–3.11
-- [pip](https://pip.pypa.io/en/stable/)
+## Requirements
+- [Supported Python version](./pyproject.toml#L4)
 - [pre-commit](https://pre-commit.com/)
+- [uv](https://docs.astral.sh/uv/getting-started/installation/)
 
-### Setting Up Your Development Environment
-Clone the repository:
-```sh
-git clone https://github.com/kubeflow/sdk.git
-cd sdk
-```
 
-Create a virtual environment and activate it:
-```sh
-python3 -m venv .venv
-source .venv/bin/activate
-```
+## Development
 
-Install dependencies in editable mode:
-```sh
-pip install -e .
-```
-
-#### Development Build (Optional)
-To install development tools and the latest API modules directly from the master branch:
-```sh
-uv pip install -e . --group dev
-```
+The Kubeflow SDK project includes a Makefile with several helpful commands to streamline your development workflow.
 
-## Development Workflow
+To install all dependencies (including dev tools) and create virtual environment, run
 
-### Pre-commit
-We use pre-commit to ensure consistent code formatting. To enable pre-commit hooks, run:
-```sh
-pre-commit install
-```
-To run all hooks manually:
 ```sh
-pre-commit run --all-files
+make install-dev
 ```
 
-### Testing
-To run the unit tests (if present), execute:
-```sh
-pytest
-```
+### Coding Style
+Make sure to install [pre-commit](https://pre-commit.com/) (`uv pip install pre-commit`) and run `pre-commit install` from the root of the repository at least once before creating git commits.
 
-### Code Coverage
-To run tests and measure coverage:
-```sh
-coverage run -m pytest
-coverage report -m
-```
+The pre-commit hooks ensure code quality and consistency. They are executed in CI. PRs that fail to comply with the hooks will not be able to pass the corresponding CI gate. The hooks are only executed against staged files unless you run `pre-commit run --all`, in which case, they'll be executed against every file in the repository.
+
+Specific programmatically generated files listed in the `exclude` field in [.pre-commit-config.yaml](.pre-commit-config.yaml) are deliberately excluded from the hooks.
 
-### Code Formatting
 To check formatting:
-```sh
-black --check .
-```
-To auto-format all files:
-```sh
-black .
-```
-To sort imports:
-```sh
-isort .
+
+```shell
+make verify 
 ```
-To lint:
-```sh
-flake8 --exclude .venv
+
+## Testing
+
+The Kubeflow SDK project includes several types of tests to ensure code quality and functionality.
+
+### Unit Testing
+To run unit tests locally use the following make command:
+
+```shell
+make test-python
 ```
 
-## Continuous Integration
-All PRs are automatically checked by CI. Please ensure all checks pass before requesting review.
+### E2E Tests
+E2E test run in CI on a kind cluster using [Kubeflow Trainer E2E Scripts](https://github.com/kubeflow/trainer/blob/master/CONTRIBUTING.md#e2e-tests).
+Clone the `Kubeflow Trainer` repo and run the provided commands against `Trainer` Makefile.
+For more details check [the Kubeflow Trainer Contributing Guide](https://github.com/kubeflow/trainer/blob/master/CONTRIBUTING.md#e2e-tests).
+
+
+## Best Practices
+
+### Pull Request Title Conventions
+
+We enforce a pull request (PR) title convention to quickly indicate the type and scope of a PR.
+The PR titles are used to generated changelog for releases.
+
+PR titles must:
+
+- Follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/).
+- Have an appropriate [type and scope](./.github/workflows/check-pr-title.yaml)
+
+Examples:
+
+- fix: Check empty value for ml_policy
+- chore(ci): Remove unused scripts
+- feat(docs): Create guide for LLM Fine-Tuning
 
-## Getting Help
-For questions, open an issue or contact a maintainer listed in `OWNERS`.
+### Kubeflow Enhancement Proposal (KEP)
 
-## Resources
-- [Kubeflow Trainer Docs](https://www.kubeflow.org/docs/components/trainer/)
-- [Source Code](https://github.com/kubeflow/trainer)
+For any significant features or enhancement for Kubeflow SDK project we follow the
+[Kubeflow Enhancement Proposal process](https://github.com/kubeflow/community/tree/master/proposals).
 
----
+If you want to submit a significant change to the Kubeflow Trainer, please submit a new KEP under
+[./docs/proposals](./docs/proposals/) directory.
diff --git a/Makefile b/Makefile
@@ -51,7 +51,7 @@ ruff: ## Install Ruff
 	@uvx ruff --help &> /dev/null || uv tool install ruff
 
 .PHONY: verify
-verify: uv uv-venv ruff  ## install all required tools
+verify: install-dev  ## install all required tools
 	@uv lock --check
 	@uvx ruff check --show-fixes
 
@@ -75,3 +75,11 @@ ifeq ($(report),xml)
 else
 	@uv run coverage html
 endif
+
+
+.PHONY: install-dev
+install-dev: uv uv-venv ruff ## Install uv, create .venv, sync deps; DEV=1 to include dev group; EXTRAS=comma,list for extras
+	@echo "Using virtual environment at: $(VENV_DIR)"
+	@echo "Syncing dependencies with uv..."
+	@uv sync
+	@echo "Environment is ready."
