From ef0c2b08199eed7ace1daf9c8ca6790a4a462a57 Mon Sep 17 00:00:00 2001 From: Yoland Yan <4950057+yoland68@users.noreply.github.com> Date: Sun, 2 Mar 2025 12:43:19 -0800 Subject: [PATCH] Add pre-commit configuration and update README for backend development --- .pre-commit-config.yaml | 13 +++++++++++++ README.md | 19 +++++++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 .pre-commit-config.yaml diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 000000000..3db42eb40 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,13 @@ +repos: + - repo: https://github.com/charliermarsh/ruff-pre-commit + rev: v0.0.241 # Use the desired version of Ruff + hooks: + - id: ruff + + - repo: local + hooks: + - id: pytest + name: Run Pytest + entry: pytest + language: system + types: [python] \ No newline at end of file diff --git a/README.md b/README.md index 9190dd493..dd634179d 100644 --- a/README.md +++ b/README.md @@ -330,6 +330,25 @@ Use `--tls-keyfile key.pem --tls-certfile cert.pem` to enable TLS/SSL, the app w See also: [https://www.comfy.org/](https://www.comfy.org/) +## ComfyUI Backend Development + +### Setup Environment + +Install pre-commit to run tests and linters + +``` +pip install pre-commit +``` + +``` +pre-commit install +``` + + +### Reporting Issues and Requesting Features + +For any bugs, issues, or feature requests related to the backend, please use the [ComfyUI repository](https://github.com/comfyanonymous/ComfyUI). This will help us manage and address backend-specific concerns more efficiently. + ## Frontend Development As of August 15, 2024, we have transitioned to a new frontend, which is now hosted in a separate repository: [ComfyUI Frontend](https://github.com/Comfy-Org/ComfyUI_frontend). This repository now hosts the compiled JS (from TS/Vue) under the `web/` directory.