# Welcome to the SD-WebUI Stable Horde Worker Bridge Extension Project

:tada: Thank you for investing your time to help us make this project better! :tada:

Read our [Code of Conduct](https://github.com/sdwebui-w-horde/.github/blob/master/CODE_OF_CONDUCT.md) to keep this community open and inclusive.

## What can I contribute?

- [Report bugs](#reporting-bugs)
- [Suggest enhancements](#suggesting-enhancements)
- [Code contribution](#code-contribution)

## Reporting bugs

This section guides you through submitting a bug report for our project.
Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behavior :computer:, and find related reports :mag_right:.

### Before submitting a bug report

- Update your SD-WebUI and extension to the latest version to see if the problem has been fixed.
- Search the [existing issues](https://github.com/sdwebui-w-horde/sd-webui-stable-horde-worker/issues) to see if the problem has already been reported.
- If you find an existing issue report, please add a comment to the existing issue instead of opening a new one.
- If you find an existing issue report that seems similar to your problem, but the solutions or workarounds don't work for you, please open a new issue report.
- Make sure you are able to reproduce the problem on the latest version of SD-WebUI and the extension.

### How do I submit a good bug report?

Explain the problem and include additional details to help maintainers reproduce the problem:

- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible.
- Provide specific examples to demonstrate the steps.
- Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
- Explain which behavior you expected to see instead and why.
- Include screenshots and corresponding logs which show you following the described steps and clearly demonstrate the problem.
- Clarify which version of SD-WebUI and the extension you are using, not just "latest version".

## Suggesting enhancements

This section guides you through submitting an enhancement suggestion for our project, including completely new features and minor improvements to existing functionality.

### Before submitting an enhancement suggestion

- Check the [existing issues](https://github.com/sdwebui-w-horde/sd-webui-stable-horde-worker/issues) to see if the enhancement has already been suggested.
- If you find an existing issue report, please add a comment to the existing issue instead of opening a new one.

### How to submit a good enhancement suggestion

Explain the enhancement and include additional details to help maintainers understand the enhancement:

- Use a clear and descriptive title for the issue to identify the enhancement.
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
- Provide specific examples to demonstrate the steps.
- Describe the current behavior and explain which behavior you expected to see instead and why.
- Describe alternatives you've considered.

## Code contribution

This section guides you through submitting a code contribution for our project.

### Before submitting a code contribution

- Update your extension to the latest version to see if your contribution has already been implemented.
- Search the [existing pull requests](https://github.com/sdwebui-w-horde/sd-webui-stable-horde-worker/pulls) to see if the enhancement has already been implemented by someone else.

### Submit a code contribution

- Fork the repository and create your branch from `master`.
- Format your code with `black .`
- Lint your code with `flake8 .`
- If you've added code that should be tested, add tests.
- If you've changed usage or APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- Issue that pull request!