chore: Update CONTRIBUTING.md to use uv

CONTRIBUTING.md

@@ -1,89 +1,116 @@
 # 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:
+## Development
+
+The Kubeflow SDK project includes a Makefile with several helpful commands to streamline your development workflow.
+
+To install all dependencies (including dev tools) and create virtual environment, run
+
 ```sh
-python3 -m venv .venv
-source .venv/bin/activate
-```
+make install
 
-Install dependencies in editable mode:
 ```sh
-pip install -e .
+make install
 ```
 
-#### Development Build (Optional)
+#### API Models
+
 To install development tools and the latest API modules directly from the master branch:
-```sh
-uv pip install -e . --group dev
-```
 
-## Development Workflow
+```shell
+uv sync --dev
+```
 
 ### Pre-commit
 We use pre-commit to ensure consistent code formatting. To enable pre-commit hooks, run:
-```sh
+```shell
 pre-commit install
 ```
 To run all hooks manually:
 ```sh
 pre-commit run --all-files
 ```
 
-### Testing
-To run the unit tests (if present), execute:
-```sh
-pytest
-```
+## Testing
 
-### Code Coverage
-To run tests and measure coverage:
-```sh
-coverage run -m pytest
-coverage report -m
+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
 ```
 
-### Code Formatting
+### 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).
+
+## 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.
+
+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.
+
 To check formatting:
-```sh
-black --check .
+
+```shell
+make verify 
 ```
-To auto-format all files:
-```sh
-black .
+
+### Using Ruff
+
+You can use ruff directly to check the linting issues before commiting your code
+
+```shell
+uv run ruff check --show-fixes
 ```
-To sort imports:
-```sh
-isort .
+
+To fix all lint issues automatically using ruff append `--fix` to your ruff check command.
+
+```shell
+uv run ruff check --fix .
 ```
-To lint:
-```sh
-flake8 --exclude .venv
+
+To auto-format, lint all files
+
+```shell
+uv run ruff format .
 ```
 
-## Continuous Integration
-All PRs are automatically checked by CI. Please ensure all checks pass before requesting review.
+## 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.

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  ## 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
+install: 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 --group dev
+	@echo "Environment is ready."