mirror of
https://git.datalinker.icu/comfyanonymous/ComfyUI
synced 2026-09-07 00:07:04 +08:00
80 lines
2.7 KiB
Markdown
80 lines
2.7 KiB
Markdown
# Contributing to ComfyUI
|
|
|
|
Welcome, and thank you for your interest in contributing to ComfyUI!
|
|
|
|
There are several ways in which you can contribute, beyond writing code. The goal of this document is to provide a high-level overview of how you can get involved.
|
|
|
|
## Asking Questions
|
|
|
|
Have a question? Instead of opening an issue, please ask on [Discord](https://comfy.org/discord) or [Matrix](https://app.element.io/#/room/%23comfyui_space%3Amatrix.org) channels. Our team and the community will help you.
|
|
|
|
## Providing Feedback
|
|
|
|
Your comments and feedback are welcome, and the development team is available via a handful of different channels.
|
|
|
|
See the `#bug-report`, `#feature-request` and `#feedback` channels on Discord.
|
|
|
|
## Reporting Issues
|
|
|
|
Have you identified a reproducible problem in ComfyUI? Do you have a feature request? We want to hear about it! Here's how you can report your issue as effectively as possible.
|
|
|
|
|
|
### Look For an Existing Issue
|
|
|
|
Before you create a new issue, please do a search in [open issues](https://github.com/comfyanonymous/ComfyUI/issues) to see if the issue or feature request has already been filed.
|
|
|
|
If you find your issue already exists, make relevant comments and add your [reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments). Use a reaction in place of a "+1" comment:
|
|
|
|
* 👍 - upvote
|
|
* 👎 - downvote
|
|
|
|
If you cannot find an existing issue that describes your bug or feature, create a new issue. We have an issue template in place to organize new issues.
|
|
|
|
|
|
### Creating Pull Requests
|
|
|
|
* Please refer to the article on [creating pull requests](https://github.com/comfyanonymous/ComfyUI/wiki/How-to-Contribute-Code) and contributing to this project.
|
|
|
|
## Development Environment Setup
|
|
|
|
### Setting Up with UV (Recommended)
|
|
|
|
*Added 2025-05-02 by kairin*
|
|
|
|
We recommend using [UV](https://github.com/astral-sh/uv) for faster, more reliable package management:
|
|
|
|
1. **Install UV**:
|
|
```bash
|
|
curl -LsSf https://astral.sh/uv/install.sh | sh
|
|
source $HOME/.local/bin/env # For bash/zsh
|
|
```
|
|
|
|
2. **Set up development environment**:
|
|
```bash
|
|
git clone https://github.com/comfyanonymous/ComfyUI.git
|
|
cd ComfyUI
|
|
|
|
# Create virtual environment
|
|
uv venv
|
|
source .venv/bin/activate # Linux/macOS
|
|
# or
|
|
.venv\Scripts\activate # Windows
|
|
|
|
# Install dependencies
|
|
uv pip install -r requirements.txt
|
|
|
|
# Install development dependencies
|
|
uv add --dev pytest black isort
|
|
```
|
|
|
|
3. **Install in development mode**:
|
|
```bash
|
|
uv pip install -e .
|
|
```
|
|
|
|
### Working with Dependencies
|
|
|
|
## Thank You
|
|
|
|
Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to contribute.
|