Skip to content

Latest commit

 

History

History
45 lines (27 loc) · 2.34 KB

CONTRIBUTING.md

File metadata and controls

45 lines (27 loc) · 2.34 KB
Raw

Contributing Guide for ComfyUI Extensions

Firstly, we would like to extend our gratitude for considering a contribution to ComfyUI Extensions. Open-source projects like this thrive because of contributors like you. This document is meant to provide you with a set of guidelines to follow for contributing to this project.

Code of Conduct

We are dedicated to providing a positive and respectful environment. Please ensure you follow our Code of Conduct throughout your interactions with this project.

How Can I Contribute?

Reporting Bugs

  1. Please check if the bug has already been reported in the existing issues before creating a new one.
  2. If you find an open issue that reports the bug you have found, you can add any additional information in the comments of that issue.
  3. If there isn't any existing issue, feel free to create a new one. Be as detailed as possible in your report.

Suggesting Enhancements

We welcome suggestions for enhancements or new features. Open an issue, label it as a 'Feature Request', and detail your suggestion. Explain why you believe it would be a good enhancement, and if possible, include visual mock-ups or diagrams.

Pull Requests

  1. Fork the repository.
  2. Clone your fork to your local machine.
  3. Create a new branch for your feature or fix.
  4. Make your changes, ensuring you follow our coding style.
  5. Push your changes to your fork.
  6. Create a pull request, detailing the changes you have made and why.
  7. Wait for a reviewer to review your pull request. They may ask for changes. Work with them to resolve any issues they find.

Please note, we reserve the right to reject a pull request if it doesn't meet the project's standards or fit with its goals.

Documentation

You can help improve the project's documentation, such as README files, guides, etc., to help new users understand the project. Any effort to clarify language, correct typos, or enhance the design of the documentation is greatly appreciated.

Style Guide

Please ensure your contributions adhere to the project's coding style to maintain consistency and readability in the codebase.

Questions?

If you have any questions or anything is unclear, feel free to open an issue labeled 'Question' or reach out to one of the project maintainers.

Once again, thank you for your interest in contributing to ComfyUI Extensions!