AEmotionStudio-ComfyUI-ShaderNoiseKSampler/CONTRIBUTING.md

Contributing to ComfyUI-ShaderNoiseKSampler

First off, thank you for considering contributing to ComfyUI-ShaderNoiseKSampler! Your help is greatly appreciated.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open-source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

How to Contribute

There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into ComfyUI-ShaderNoiseKSampler itself.

Getting Started

To get started with development:

1. Fork the repository on GitHub.
2. Clone your fork locally:

   git clone https://github.com/your-username/ComfyUI-ShaderNoiseKSampler.git
   cd ComfyUI-ShaderNoiseKSampler
   

3. Set up your development environment. This project is a custom node for ComfyUI. You should have a working installation of ComfyUI. Place your cloned repository inside the ComfyUI/custom_nodes directory.

Contribution Workflow

1. Create a new branch for your feature or bug fix:

   git checkout -b feature/your-amazing-feature
   

2. Make your changes. Write clean, commented code.
3. Test your changes thoroughly.
4. Commit your changes with a descriptive commit message:

   git commit -m "Add some amazing feature"
   

5. Push your changes to your fork:

   git push origin feature/your-amazing-feature
   

6. Open a pull request to the main repository.

Coding Standards

• Follow the existing code style.
• Write clear and concise comments where necessary.
• Ensure your code is well-tested.

Reporting Bugs

Before reporting a bug, please check the existing issues to see if someone has already reported it.

When filing a bug report, please provide the following information:

• A clear and descriptive title.
• A detailed description of the bug.
• Steps to reproduce the bug.
• Your ComfyUI version and relevant system information.
• Any relevant console logs or screenshots.

Suggesting Enhancements

If you have an idea for a new feature or an improvement to an existing one, please open an issue to discuss it. This allows us to coordinate our efforts and avoid duplicating work.

When suggesting an enhancement, please provide:

• A clear and descriptive title.
• A detailed description of the proposed enhancement.
• Any mockups or examples that might help illustrate your idea.

Code of Conduct

This project and everyone participating in it is governed by the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code.