diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index c238a6a..218b83a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -6,20 +6,41 @@ assignees: acorderob --- -**Describe the bug** -A clear and concise description of what the issue is. +## Prerequisites -**To Reproduce** -Steps to reproduce the behavior +Please answer the following questions for yourself before submitting an issue. **YOU MAY DELETE THE PREREQUISITES SECTION.** -**Expected behavior** -A clear and concise description of what you expected to happen. +- [ ] I am running the latest version +- [ ] I checked the documentation and found no answer +- [ ] I checked to make sure that this issue has not already been filed +- [ ] I'm reporting the issue to the correct repository (for multi-repository projects) -**Screenshots** -If applicable, add screenshots to help explain your problem. +## Current Behavior -**Commit where the problem happens** -Installed commit or version tag +What is the current behavior? -**Additional information** -Add any other context about the problem here. +## Expected Behavior + +Please describe the behavior you are expecting + +## Failure Information (for bugs) + +Please help provide information about the failure if this is a bug. If it is not a bug, please remove the rest of this template. + +## Steps to Reproduce + +Please provide detailed steps for reproducing the issue. + +1. step 1 +2. step 2 +3. you get it... + +## Context + +Please provide any relevant information about your setup. This is important in case the issue is not reproducible except for under certain conditions. + +- WebUI used and version: + +## Failure Logs + +Please include any relevant log snippets or files here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 9a6dc69..011d043 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -6,14 +6,19 @@ assignees: acorderob --- -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +## Prerequisites -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +Please answer the following questions for yourself before submitting an issue. **YOU MAY DELETE THE PREREQUISITES SECTION.** -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +- [ ] I am running the latest version +- [ ] I checked the documentation and found no answer +- [ ] I checked to make sure that this issue has not already been filed +- [ ] I'm reporting the issue to the correct repository (for multi-repository projects) + +## Description + +A clear and concise description of the feature that you want. + +## Additional context -**Additional context** Add any other context or screenshots about the feature request here. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..9c91bf2 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,39 @@ +# Pull Request + +## Description + +Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. + +Fixes # (issue) + +## Type of change + +Please delete options that are not relevant. + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] This change requires a documentation update + +## How Has This Been Tested? + +Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration + +- [ ] Test A +- [ ] Test B + +**Test Configuration**: + +- WebUI used and version: + +## Checklist + +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing unit tests pass locally with my changes +- [ ] Any dependent changes have been merged and published in downstream modules +- [ ] I have checked my code and corrected any misspellings diff --git a/README.md b/README.md index a0e669e..7b5eea4 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,13 @@ you will have to rename one of the folders, so that it loads before than "Send t When in doubt, just rename this extension's folder with a "z" in front (for example) so that it is the last one to load, or manually set such folder name when installing it. +## Installation + +1. Go to Extensions > Install from URL +2. Paste https://github.com/acorderob/sd-webui-sendtonegative in the URL for extension's git repository text field +3. Click the Install button +4. Restart the webui + ## Usage The format of the tags is like this: @@ -68,3 +75,11 @@ default is ", ". By default it ignores repeated content and also tries to clean up the prompt after removing the tags, but these can also be changed in the settings. + +## License + +MIT + +## Contact + +If you have any questions or concerns, please leave an issue, or start a thread in the discussions.