OPENGIT/stable-diffusion-webui
1
0
Fork 0
mirror of https://github.com/AUTOMATIC1111/stable-diffusion-webui.git synced 2024-12-29 19:05:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated Contributing (markdown)

AUTOMATIC1111 2023-01-09 19:32:57 +03:00
parent 4a110fd370
commit 3127594786
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Contributing.md

@ -1,14 +1,16 @@
# Pull requests
To contribute, clone the repository, make your changes, commit and push to your clone, and submit a pull request.
Make sure that your changes do not break anything by running [tests](Tests).
If you're adding a lot of code, consider making your contribution an [extension](Extensions), and only PR small changes you need in main code to make the extension possible.
* if you adding a lot of code, consider making it an [extension](Extensions) instead.
* do not add multiple unrelated things in same PR.
* make sure that your changes do not break anything by running [tests](Tests).
* do not submit PRs where you just take existing lines and reformat them without changing what they do.
* if you are submitting a bug fix, there must be a way for me to reproduce the bug.
If you are making changes to used libraries or the installation script, you must verify them to work on default Windows installation from scratch. If you cannot test if it works (due to your OS or anything else), do not make those changes (with possible exception of changes that explicitly are guarded from being executed on Windows by `if`s or something else).
# Code style
I mostly follow code style suggested by PyCharm, with the exception of disabled line length limit. Please do not submit PRs where you just take existing lines and reformat them without changing what they do.
I mostly follow code style suggested by PyCharm, with the exception of disabled line length limit.
# Gradio
Gradio at some point wanted to add this section to shill their project in the contributing section, which I didn't have at the time, so here it is now.