Skip to content

Latest commit

 

History

History
47 lines (28 loc) · 2.52 KB

CONTRIBUTING.md

File metadata and controls

47 lines (28 loc) · 2.52 KB

Contributing Guidelines

Thank you for your interest in contributing to the ComfyUI-FurryDiffusion project! We welcome contributions from the community to help improve and enhance our project. Please take a moment to review the guidelines below before submitting your contribution.

Getting Started

To get started with contributing to ComfyUI, please follow these steps:

  1. Fork the repository.
  2. Clone the forked repository to your local machine.
  3. Create a new branch for your contribution.
  4. Make your changes and commit them with descriptive messages.
  5. Push your changes to your forked repository.
  6. Submit a pull request to the main repository.

Code Style

We follow a consistent code style throughout the project. Please ensure that your code adheres to the following guidelines:

  • Use meaningful variable and function names.
  • Write clear and concise comments.
  • Follow the indentation and formatting conventions used in the existing codebase.
  • Use appropriate design patterns and best practices.

Testing

Before submitting your contribution, please ensure that your changes pass all the existing tests and write new tests if necessary. This helps maintain the quality and stability of the project.

Reporting Issues

If you encounter any issues or have suggestions for improvements, please open an issue on the GitHub repository. Provide a clear and detailed description of the problem or suggestion, along with any relevant information or steps to reproduce the issue.

Code of Conduct

We expect all contributors to adhere to our code of conduct.

  1. Please be respectful and considerate towards others when participating in the project.

  2. No foul language, personal attacks, spam, harrassment, hate-speech, or discrimination (of any nature).

  3. Refrain from political discusisons and discussions surrounding current events on the issue tracker, in the support thread, and in direct correspondence as it partains to the project.

  4. Please do your best in English. We do not support correspondence in other languages at this time.

  5. Please refrain from posting NSFW content anywhere here on the GitHub. This does not align with their terms of use and we risk being takne down. We have the Furry Diffusion Discord Server for any NSFW-related inquiries.

  6. Adding malware or malicious code of any kind in your contribution is strictly prohibited, will have your PR / changes reverted and you blocked from contributing to this repository, discussion threads, and reported to Furry Diffusion community administration. Just don't do it!